テクニカルライティングのポイント

参考元

Google社のテクニカルライティングの基礎教育資料がとても良かったので紹介したい - Qiita

ポイント

• 用語は文書内で一貫性をもたせる
• 曖昧な代名詞の利用は避ける
• 受動態は避け、能動態を優先する
• 強い動詞を選択する1
• 曖昧な動詞よりも意味が限定される動詞を選ぶ
• 1文1メッセージ
• 長い文章はリスト形式に変換する
• 不要な言葉は排除する
• 順序が重要な場合は番号付きリストを使用し、順序が重要でない場合は箇条書きリストを使用する
• リストを使う場合は言葉の並列性を保つ
• 番号の付いたリストは命令語で始める
• リストと表を適切に使う
• 段落の骨子を示す良いリード文を作る
• 1段落1トピックに絞る
• 読み手に伝えるべきことを定義する
• 読み手を意識して書く
• ドキュメントの最初にそのドキュメントの重要なポイントを明確に示す