Skip to content

Instantly share code, notes, and snippets.

/gist:5047072

Created February 27, 2013 10:50
Show Gist options
  • Save anonymous/5047072 to your computer and use it in GitHub Desktop.
Save anonymous/5047072 to your computer and use it in GitHub Desktop.
Download ZIP
引き継ぎで惨劇を回避する為に作るべきドキュメント
Raw
gistfile1.md

引き継ぎで惨劇を回避する為に作るべきドキュメント

引き継ぎで不幸が生まれるのを経験したり見たりした為に、なんとかしたくてコレを記す。パブリックドメインな文章とするので、自由に改変するなりなんなりして欲しい (このドキュメントを成長させていきたい)

伝えなければならないものは何か？

人間

  • 関係者一覧

要望

  • 誰が出したどういう要望があるのか

思想

  • 例外的な事 (わざわざこうせざるを得なかった、制限があったなど)
  • 設計/実装されている、ある部分は、どういうものと比較してそれが選択されたのか？ (どうして？何故？)

境界面の仕様

  • API仕様
  • 入出力仕様 (たとえばバッチであれば、どういうファイルを受け取って、どういうデータベースをいじって…など)
  • 受け入れテスト (文章でもいいし、自動実行のバッチでもいいし、何らかの形で残す)
  • 用語集 (出来ればドメインに従った統一された用語)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment