エンジニアのためのドキュメントライティングの感想
読んだ後に理解した状態になっておきたい項目
管理する価値のあるドキュメントの特徴
ドキュメントを作成することによって「どんなユーザー」が「どんな時に」「どんな行動」をするときに「どんな効果」があるかを調査する必要がある。
そのため、１つずつフォーカスするために想定ユーザーのペルソナを決定する。
ユーザーストーリー 「あるユーザー」として「あるゴール」を達成するために、「ある行動」をしたい
ドキュメントの管理する文化の作り方
管理方法
ドキュメント計画
ドキュメントの種類
ドキュメントの種類を知ることは目的を達成するための適切なフォーマットを決められることにつながる。ドキュメントの種類とそれぞれの特徴を記載する。
コードコメント
README
スタートガイド
コンセプトドキュメント
リファレンスドキュメント
- APIリファレンス
手順書
- チュートリアル