技術的な執筆の5つの基本原則は何であるか。

Hero Images/Hero Images/Getty Images

テクニカルライティングは、企業のカスタマーサポート戦略の最も重要な要素の一つであり、テクニカルライターが成功するために心に留め これらの5つの領域のいずれかに不注意は、多くの場合、標準以下の文書やクライアント側の不満につながります。

質の高いコンテンツは、技術的な執筆に関して最も重要な原則です。 誰がユーザーガイドを読むのかという意識、ユーザーガイドが満たしている知識のギャップ、ガイドの配信方法はすべて重要な役割を果たします。

ユーザーガイドの目的を知ることは、特にガイドの視聴者に関して重要です。 コミュニケーションにおける作家の責任を知ることと同様に、教育テキストを書くときには、ユーザーの偏見を理解することが重要です。

文書のアクセシビリティは、ナビゲーションの容易さを指します。 文書がPDFの場合、リンクは読者を目次からそれぞれのセクションに連れて行く必要があります。 また、テーブルやイラストのリストは必見です。

適切な文法で書くことは明白に見えるかもしれませんが、技術的背景を持つ多くの人々は書かれたコミュニケーションに苦労しています。 文法と使用法は明確であり、エラーがない必要があります。

文章のスタイルは、テクニカルライターが覚えておくべき最終的な原則です。 異なったタイプの執筆に異なった聴衆があり、各聴衆に作家が調子および単語の選択と尊重する自身の言語必要性がある。

広告

コメントを残す

メールアドレスが公開されることはありません。