未知の技術導入におけるドキュメント作成のすすめ
多くのエンジニアやプロダクトマネージャーが、ドキュメントを書く必要があると感じつつも、なかなか取りかかれないことが多いのではないでしょうか?
今回は、私がどのようにドキュメントを作成しているか、そのサンプルを紹介しつつ、未知の技術を導入する際のポイントについても触れていきます。
ドキュメントを書く目的ドキュメントを書く目的はいくつか考えられます。例えば:
認識齟齬を減らす:チームメンバー間での共通理解を確立するため。
将来の誰かに向けて残す:後からプロジェクトに参加する