べるべる研究日誌

なんでもやる系エンジニアの日々

デザインドキュメント

ちゃんと作っている物に対して、デザインドキュメントを残そうと努力中。GoogleのDesign Docを参考にしていこうかなと。

DesignDoc
Googleで必ず書くことになっているドキュメント
・プロジェクト立ち上げ時の1〜2週間をかけて書く。ある程度ポイントが書けたら、もうコーディングへ。

DesignDocの内容
・プロジェクトの背景、目的
・おおまかな設計(コードを見ただけでは判らないような、アーキテクチャ)
・プロジェクトの参加者(このプロジェクトに関して、誰に連絡を取ればいいのか)
・セキュリティやプライバシーについての考察(問題と対処方法)
・テスト、モニタープラン(運用時の考慮。障害の発見と復旧手法など)
レポジトリ上の位置やサーバのアドレスなど
・コードを書いていると解離していくので、できるだけ解離しないようにアップデート

へ〜たのめも:Google のソフトウェア・エンジニアリング - livedoor Blog(ブログ)

めんどくさがっては進まない。この辺を基本に自分なりのテンプレートを作成して、素早く効率的に作っていく仕組みを検討中。