開発前に一枚程度のドキュメントを書く話があったよねと、うろ覚え状態だったのを発掘したのでメモ。
Amazonのプレスリリース。(開発の最初に書く)
見出し
顧客が商品を理解できるタイトル
副題
ターゲット層と、彼らのメリットを1行で。
概要
商品の特徴と利点をまとめる。この段落で全てを理解できるように。
課題
このプロダクトが解決する課題を説明。
解決
プロダクトがどのように課題を解決するかを説明。
コメント
自分による紹介コメント(社長のコメント的なもの)。
使い方
どれくらい使い方が簡単かを説明。
ユーザーからの声
仮想ユーザーからのコメント。
締め
最後にしめ、次にユーザーがどうすればいいかを示す(Amazonで買えます!等)。
Amazon流の開発術では、まずプレスリリースを作る (2012-08-10)
GoogleのDesign Doc。
- Google で必ず書くことになっているドキュメント
- プロジェクト立ち上げ時の 1~2週間をかけて書く。ある程度ポイントが書け たら、もうコーディングへ。
- 一般的にはあんまり長くない。詳細を書かなきゃいけなくなったら、それ はまた別プロジェクトになることが多い
- Design Doc の内容
- プロジェクトの背景、目的
- おおまかな設計(コードを見ただけでは判らないような、アーキテクチャ)
- プロジェクトの参加者(このプロジェクトに関して、誰に連絡を取ればいいのか)
- セキュリティやプライバシーについての考察(問題と対処方法)
- テスト、モニタープラン(運用時の考慮。障害の発見と復旧手法など)
- レポジトリ上の位置やサーバのアドレスなど
- コードを書いていると解離していくので、できるだけ解離しないようにアップデート
Google のソフトウェア・エンジニアリング (2007-06-07)