技術ドキュメントを書くテクニック ～ちょっとの心がけで読みやすく。社内ドキュメントからブログ、雑誌記事、そして技術書まで～

社内ドキュメントやブログ、雑誌記事、書籍に至るまで、技術ドキュメントを書く場面はたくさんあります。

技術ドキュメントは、「わかりやすく伝える」ことが大事です。そのためには、内容が正しければよいだけではなく、誤読せず素早く読める文章の構成も大事です。これは「前提をきちんと説明する」「筋道を立てる」「用語を乱さない」「読み慣れた平易な言葉」を使うなど、書くときの心がけで向上する部分も大きいです。

また社内ドキュメント、ブログ、雑誌記事、書籍は、どれも文章ですが、読み手が欲しい情報が違うため、書き方のテイストをあえて変える場面もあります。

このセミナーでは、さまざまな技術ドキュメントの書き方やテクニックについてお話します。