基本事項 †
ドキュメンテーションの目的と心得 †
- 完璧なドキュメントを書こうとしない。70点で合格。
- ドキュメントの共同所有を進めよう
- ドキュメントは気軽に書こう
ドキュメンテーションする／しない？ †
口頭で伝える人的負荷と「書かないリスク」を考える。
ドキュメントの品質特性 †
- 必要十分性 ... 目的を達成するために必要な情報が、過不足なく提供されているか？
- 正確性
- 情報の正確性 ... 情報が誤りなく提供されているか？
- 表現の正確性 ... 情報が正しく表現されているか？
- わかりやすさ ... 内容が容易に理解できるようになっているか？
- 検索しやすさ ... 欲しい情報がすぐに見つかるようになっているか？
- 魅力 ... 読む気になるかどうか？
- 法規・規約の遵守 ... 著作権を侵害していないか？差別的表現はないか？
ドキュメンテーションの類型 †
リファレンスドキュメンテーション †
ファイルコメント †
クラスコメント †
関数コメント †
デザインドキュメント †
チュートリアル †
概念的ドキュメンテーション †
ランディングページ †
リンク集 †
![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
