テクニカルライティングの4大原則

「短く書け、明快に書け、絵のように書け、そして何よりも正確に書け ― ジョセフ・ピューリッツァー」

① 明確性 (Clarity) : キーワードや中核となる文が曖昧に使われず、技術文書を読む際に内容の曖昧さや混乱なく一度で理解できるようにすること

② 簡潔性 (Conciseness) : 技術的な内容を迅速かつ正確に理解できるよう、美辞麗句や感嘆詞などを使わず、簡単でわかりやすい単語と簡潔な文を使うこと

③ 正確性 (Accuracy) : 読者が必要とする情報を技術的な誤りなく正確に提供すること

④ 一貫性 (Coherence) : 文書内で用語、表現、そして文体などを一貫して使用すること

[junghan0611]

ありがとうございます

[xguru]

• Google テクニカルライティング for エンジニア [英語] https://ja.news.hada.io/topic?id=1642