【どきゅめんと】
ドキュメント（技術文書） とは？
💡 「あれ、これどう動くんだっけ？」の答えが書いてある場所
📌 このページのポイント
ひよこ 先輩に「ドキュメント読んで」って言われたんだけど、どこにあるんだ
ペンギン先生 社内のWikiや共有フォルダに置いてあることが多いよ。設計書や手順書など、技術的な情報をまとめた文書のことをドキュメントと呼ぶんだ
ひよこ 開発で忙しいのに、わざわざ文書を書く必要あるのか
ペンギン先生 ドキュメントがないと、作った本人しかわからないシステムになってしまうんだよ。担当者が異動や退職したら誰も触れなくなるんだね
ひよこ それは困るな。でも書くのが面倒で後回しにしちゃいそうだ
ペンギン先生 気持ちはわかるけど、後から書こうとすると余計に大変になるんだよ。開発しながら少しずつ書いていくのがコツなんだ
ひよこ いいドキュメントとダメなドキュメントの違いって何なの？
ペンギン先生 いいドキュメントは「なぜそうしたのか」が書いてある。ダメなドキュメントはコードの内容をそのまま繰り返しているだけ。コードを見ればわかる「何をしているか」より、コードからは読み取れない「なぜこの設計にしたか」が重要なんだ
ひよこ ドキュメントって自動で作れないの？
まとめ：ざっくりこれだけ覚えればOK！
「ドキュメント」って出てきたら「システムや技術の情報をまとめた文書のこと」と思えればだいたいOK！
📖 おまけ：英語の意味
「Documentation」 ＝ 文書化・文書群
💬 「Document（文書）」を作成する行為そのものを指す言葉だよ。「ドキュメントを書く」はエンジニアの大事な仕事のひとつなんだ