KDOC 717: Google のデザインドックのテンプレート

この文書のステータス

  • 作成
    • 2026-10-18 貴島
  • レビュー
    • 2026-10-18 貴島

概要

デザインドックは、プロジェクトを始める前に書く設計書である。これをもとに人や資源を集め、期間を決め、メンバーの理解をそろえる。

次は、Googleのデザインドックのマークダウンサンプルとされるgist(最終コミット2016-07-05)をそのまま写したものである。gist自身も冒頭でブログから持ってきたと書いており、Googleのものかは確かめていない。 

[こちらから持ってきました](http://diary.overlasting.net/2010-01-27-4.html)
[Google のソフトウェア・エンジニアリング](http://blog.livedoor.jp/heitatta/archives/54439839.html)
[「書く」のは特別な道具](http://d.hatena.ne.jp/naoya/20131107/1383792634)

[例：作成するライブラリの名前は]

[何を実現するの？]

[どんな背景があるから実現するの？]

[コードだけでは分からない作成物のアーキテクチャを画像などで]

[連絡先が大切。誰が参加するのかを明らかにしよう]

## 実装する仕様
[事前に仕様が決まっていたら]

## 既存のものとの相違点
[既存のものと何が違うのか、比較対象の仕様があれば言えるだろう。]

## 関連する仕様
[関連する仕様があれば]

[各クラスの概要を書く。]

## インターフェイス
[各クラスのインターフェイスの概要。hファイルや、javadocやpod形式かな。関数や構造体を定義するコードとコメント。]

## 処理フロー
[「どのように処理をおこなうか」を各関数内の処理フローを上記で説明したインターフェイスに基づき、自然言語で詳細に書く]

## 作成物の使用例
[おもにサンプルコード]

[考えられる問題と、それに対する対処方法]

[事前にわかっている様々な課題]

[思いついたテストを思いついただけ書く]
[テストケースの記述]
[運用時の考慮。障害の発見方法や、復旧方法など]

[参考文献を書く]

[サーバのアドレスや位置]

[編集日、編集者、何をしたのか、の3つ組を書く]

関連