/note/tech
MEMO:
- 目的を明確にする
- 何の為に、何を伝えるのかを定義
- 目的を一言で定義できると理想
- 目的はドキュメントの冒頭に書いておく
- 筋道を立てて書く
- 読み手が知っている/理解しやすい事から順を追って説明
- 全体から部分へ
- 概要から詳細へ
- 既知から未知へ
- まず重要な事柄から説明
- まず相手が知りたい事柄から説明
- 手順や流れに沿って説明
- 読み手の視点
- 具体的な読者のペルソナを想定
- 読み手の行間補完能力に期待しない
- 読み手を置き去りにしない
- ドキュメントの冒頭に要点を書いておく
- 一文一義、一文50文字以内にする
- 図表を使う
- 比較や手順は表が分かりやすい
- 具体的な対象があるならキャプチャや写真
- 流れはシーケンス図など
(2023/02/05)