【エンジニアのためのドキュメントライティング術】最低限知っておきたい、ドキュメントの重要性と書きはじめる前の準備

エンジニアのためのドキュメントライティング術 第1回

　一定の規模の開発であればドキュメントは必須です。ドキュメントを使わない開発が存在するならば、すべての情報を口頭やチャットを使い、ソースコードレベルで記述する必要があります。一方で、効果的に記述されて運用されているドキュメントには、開発組織・チームをスケールさせる力があります。ドキュメントは互いの時間を拘束せずに非同期で書いたり、読んだりできるからです。したがって、ドキュメントを効果的に使えるならば、開発組織・チームの生産性を向上できます。しかし、ドキュメントの書き方をしっかり学んでいる人は多くないです。もしドキュメントライティングの基礎技術を事前に身につけられるならば、今後の開発者人生において非常にレバレッジの効くスキルとなります。本記事では、ドキュメントライティング術を学んだことがない人向けに、「ここまでは最低限知っておくと良い」という知識をお伝えします。