Skip to content

Instantly share code, notes, and snippets.

@erukiti
Forked from anonymous/gist:5047072
Last active December 14, 2015 06:59
Show Gist options
  • Save erukiti/5047667 to your computer and use it in GitHub Desktop.
Save erukiti/5047667 to your computer and use it in GitHub Desktop.
引き継ぎで惨劇を回避する為に作るべき情報は何かをまとめてみた

引き継ぎで惨劇を回避する為に作るべき情報は何か

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

「情報」はドキュメントという形、あるいはソースコードのコメントなど、形式はこのテキストにおいては扱わない。また、なるべくDRY原則に従った形で情報を残すべきだとは思うが、このテキストでは詳細には踏み込まない。

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

人間

  • 関係者一覧

要望

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

思想

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

境界面の仕様

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