ドキュメントを書く時の定石集

SE が良いドキュメントを書くための定石をまとめます。

目次

全てのドキュメントに書くべきヘッダ

全てのドキュメントで個別に定めておくべきルール

ドキュメント作成で心掛けること

言葉べからず集

テンプレート

分かりやすく、抜け漏れのないドキュメントを効率良く書くためのテンプレートを作りました。以下よりダウンロードして参考にしてください。