Googleのテクニカルライティング基礎教育資料

Every engineer is also a writer.

わかりやすい

短い

曖昧な動詞よりも意味が限定される動詞を選ぶ

段落の骨子を示す良いリード文を作る

言葉の並列性を保つ

読者がすでによく知っているものと比較する

ユーザーによってそれぞれ異なる資料形態を提供する

複数の例を見せる

読者がつまづきやすい点を指摘する

確認する

継続的に見直す

書く前 or 書いた後

新しい概念・指示など

作成する前に、説明書きを書いてみる

1つの図面内の情報量を制限する

適切な箇所に読者の注意を向ける

キャプションで要点を説明する

注意を惹くマークを追加する

良い例だけでなく、良くない例も提供する

複数の複雑さを想定したものを提供する

短くするが、簡潔さよりも明快さを優先する

自明なコードには書かず、直感的でない部分を明らかにすることに集中させる

public.icon