業務で作成されるドキュメントの種類や特徴について

経緯

最近、業務で各種ドキュメント作成をしていて思うところがあったので、頭の中を整理する意味で書き出してみることにした。

ドキュメントの種類

環境構築やツールの仕様方法に関するもの

• 頻繁に参照されたり更新される
• ドキュメント通りに操作しないと動かないから

コーディング規約や命名規則といったルールに関するもの

• 見られることが少ない、見られても実践されない
  • 守らなくても別に困らないから

実装された機能の仕様に関するもの

• 最初の実装時に作成されても、その後、更新されないことが多い
  • ドキュメントまで気が回らない
  • ドキュメントを更新しなくてもシステムは動くので問題視されない
  • 情報が古いと、後からアサインされた人が困る可能性がある

所感

• システムにとってクリティカルなもの(困るもの)じゃないと参照されないもんだなー。。
  • そこは当たり前だとは思う
• 使わないドキュメントは作らないほうが良いのでは…時間と労力に見合わないし。
• ルールに関するものについては、ドキュメント云々よりも「ちゃんとルールとしてそれを守る」という姿勢を持つのが先決かと。