辞書: 設計書

投稿日: 2018-05-23

設計書とは

あまり時間はかけたくないけど、ちゃんと書かないといけないものです。

自分も後回しにしがちなのですが、設計書はちゃんと書かないとダメです。理由はもちろん「自分以外の人がやる可能性があるから」です。逆に言えば、ドキュメントがないと、他の人に引き継ぎできません¹。

もし１人体制だったとしても、そのエンジニアが将来に渡ってずっと退職もせずに休みもせずに働いてくれるのなら問題ないかもしれません。しかし企業経営を考える上でそんなお花畑的な思考であってよいはずはなく、退職するリスクや病気になるリスクも考えておく必要があります。だからこその複数人体制です。

どんな業務でも「自分以外の誰かがこの業務を引き継ぐ可能性がある」ことを視野に入れておく必要があり、だからこそドキュメントを残しておくことは継続的なシステムの保守を行っていく上で重要です。

よく言われるのが、Excel(しばしばExcel方眼紙)はダメだという意見です。これは理解できますし、自分もExcelは使いたくないです。ただ、いろいろ試行錯誤してみましたが、まだ決定版がありません。

今のところ、Markdown + 図をPlantUMLなどで書くというのが近いと思います。以下のサイトでも述べられています。

ただ、「図をテキストで書く」というのが、まだ洗練されてない感じです。さらに言えば、「図を描く」ということに対して、標準的な方法が確立されていません。