背景
ゼロからドキュメントを書き出す際、基本構成のガイドラインがあると品質の低下を防げて、作成の効率が上がるため。
この型で何ができるようになるか
ドキュメントの全体構成で大きく外すことなくドキュメントを書くことができる。
この型が具体的にどのような人、場面に役立ちそうか
- ゼロベースでドキュメントを書いたことがない人
- ゼロベースでドキュメントを書くときに構成に迷う人
型
章 | 記載内容 | 記載例 |
---|---|---|
タイトル | 内容の概要が分かるような一言 | 〇〇案件のインボイス対応 |
前提、背景、経緯 | 誰かが読んだときに理解の助けになるような、記載した背景や理由 | インボイスの要件が複雑かつ分かりづらいため、ここに要点と詳細をまとめる。 |
目的 | 読後にどのような状態になることを目指したドキュメントか | インボイスの要件を理解し、案件を推進できるようになること |
概要 | いいたいこと、主張、結論などを書く | 下記がポイント ・対応箇所は帳票出力のみ ・2022/xx以前の帳票は対応しない ・2022/xx以降の帳票を対応する ・画面にインボイス向け項目を新規追加する ・帳票出力機能を新規追加する ・退会済ユーザーからの問い合わせは運用対応する |
詳細 | 概要を説明する詳細内容を記載 | (省略) ※各要件を検討した際のマトリクスやメリデメ比較表、結論と理由・背景などを記載する。 |