山下寛人オフィシャルブログ

オイシックス株式会社 執行役員 システム本部長 山下寛人の公式ブログです。

やっぱりドキュメントはいらないかもしれない

新しく入ってくる人にドキュメントがなくて困ると言われ開発時にドキュメントを書くということを何年もやってきましたがやっぱりいらないかもしれません。特に外部設計書。全部の画面の設計書がそろっていれば新しく入ってきた人はすぐにシステムを理解することができ、追加の開発をするときもすでにあるドキュメントをアップデートすればよくなります。障害対応や調査依頼のときも約に立つはず。と思っていましたがいまだに外部設計書は全部を網羅できないし新しく入ってくる人や保守担当も全然ドキュメントは見ていません。ということをさっき聞いて知りました。

もっと早くやめていればよかった。
結局どうやってシステムを知るかというとテスト環境とソースコードです。ソースは大事です。

新しい人向けにはそれ用の概要説明資料を作る。アップデートは新しく入った人が自分でやる。画面遷移図くらいはあったほうがいいですかね。