ドキュメントの設計を学ぶ
日々の業務のアウトプットとして、設計書、手順書、運用マニュアル、検証レポートなど、さまざまなドキュメントを作る機会があると思います。私自身も機能説明資料や設計書、運用マニュアルなどを作成しており、「読みやすく・わかりやすい」ドキュメントの作成が常に求められています。 ところで、 「君の資料、分かりづらいね」 と言われたことはありませんか？恥ずかしながら、私は過去に指摘を受けたことがあります。それをきっかけに「どうすれば読みやすいドキュメントが書けるのか」を書籍などで学んできました。そんな中で最近良い書籍を見つけたのでご紹介します。 「 エンジニアが一生困らないドキュメント作成の基本」 この本では、文章のセンスではなく「ドキュメントの構造（アウトライン）をどう設計するか」に焦点を当てています。私自身、過去の経験から「アウトライン」の重要性を感じていますが、本書ではその手法が体系化されており、非常に参考になりました。 要約資料: https://speakerdeck.com/naohiro_nakata/basics-of-documentation-for-engineers 書籍情報: https://amzn.asia/d/iXqopBy 出版社サイト: https://www.socym.co.jp/book/post-19000 個人的なドキュメント作成のスキルアップだけでなく、新しいメンバーが設計書や運用手順書を初めて作る際の“教科書”としても使えそうです。また、ドキュメント作成は個人のスタイルが表れやすいため、共通知識として本書を活用することでチーム全体のドキュメント品質を揃えるためのガイドラインにもなりそうです。 ご興味があれば、年末年始のインプットとしていかがでしょうか。 それでは、良いお年をお迎えください。