ドキュメントの多寡について考える¶
地理的に分散したチームメンバーが非同期でコミュニケーションしながら一つのチームとして一つのプロダクトを成長させていく、というケースを考える
- GitLab的なアプローチ
- https://about.gitlab.com/handbook/
- あらゆることをドキュメントに書き、ドキュメントへのリンクを案内して質問に回答する
- Zucks的なアプローチ
- https://twitter.com/t_wada/status/1298065395929059329?s=20
- ドキュメントなしでもわかるようにIssueを書き、コードを書く
- Engineers in VOYAGE p65より抜粋
- https://gyazo.com/08889e1d07f4230d5de114af37a623ba
ドキュメントに書けない機微な情報についてはどうするか
- 入退社
- 給与
- 評価
ドキュメント書きたくない問題
- 自然言語の文章を書くこと自体が難しい
- どうせ更新されなくなるくらいなら書かずに済ませたい
ドキュメント更新されない問題
- 読まれない
- 自分自身には必要がないので更新しない
ドキュメント探しづらい問題
- 同じ内容が複数の場所に書いてある
- 検索でヒットしたドキュメントへのアクセス権がない