以前の「未来の自分を信頼し過ぎない」ことを書きました。
とはいうものの、何でもかんでもドキュメント化するのではなく、いくつかの要因(例として必要度合い)から判断して作るか決めれば…とも書きました。
私は、その判断基準に一つに「(その事柄について)何度聞かれたか？」という点があります。
例えば、プログラムの実装方針(Sessionの持ち方等)や、よくあるのが開発環境構築の際の細かい設定やDBへの接続文字列やサーバへのリモート接続の方法等です。
例に挙げた実装方針などはアプリケーション自体の品質にかかわりますので、よく検討した上、明文化され、プロジェクト間で共有できているのが当たり前ではあります。
ただそれ以外では…
A：「サーバへの接続文字列なんでしたっけ？」
リーダー：「パスワードはXYZやで」
A：「あ、分かりました。(接続して作業する)」
…で、また数日後…
C：「サーバへの接続文字列なんでしたっけ？」
リーダー：「パスワードはXYZやで」
…となることが多いように思います。
同じ質問を別の人からされたのであれば、N人にとって必要だったわけです。
そして、今後も(未来の自分も含めて)質問されると思うのが妥当という判断をして、ドキュメント化したりWikiにしたりするわけです。
※注意：この記事は旧サウスポーなエンジニアの独り言から移行し一部修正したエントリです。
Photo via VisualHunt
コメント