テクニカルライティングの基本原則

時々、テクニカルライティングの基本原則を再訪する必要があります。 私たちが1997年に始まって以来、技術的な執筆の基本原則は、コミュニケーションのモードが変化しても同じままでした。

目的と対象者

新しい執筆プロジェクトを開始する前に、テクニカルライターは文書の目的を分析し、意図した対象者を特定する必要があります。 作家は尋ねる必要があります:

• 誰がドキュメントを読むのですか？
• 彼らの偏見は何ですか？
• 聴衆に情報を伝えるとき、私はどのような責任を持っていますか？

スタイルガイド

テクニカルライターは、ドキュメントに構造化されたパターンがあることを確認するために、会社のスタイルガイドを使用することが スタイルガイド（AP Stylebookなど）は、ドキュメントの外観、使用する言語、アイデアの配置方法に関するガイドラインを提供します。 この組織は、文書または一連の文書に連続性を与えるので、聴衆は情報を簡単に理解することができます。 たとえば、テクニカルライターは、スタイルガイドに記載されているように、プロセスを時系列に文書化することができます。 その構造がなければ、読者は混乱し、プロセスに従うことができません。 スタイルガイドは、より一貫性と読みやすく書くことができます。

執筆スタイル

テクニカルライターは、聴衆と彼らが書いている状況に応じて執筆スタイルを変更します。 彼らが技術文書を書いているならば、スタイルはあなたが創造的な執筆で得る感情を欠いている正式なものでなければなりません。 彼らがプロジェクトに関わる上級管理職の一人に電子メールを書いているなら、彼らのスタイルはより会話的になるでしょう。

情報へのアクセス

アクセシビリティとは、文書内の情報を意図した対象者がいかに簡単に取得できるかということです。 技術文書には、目次、ヘッダー、フッター、ページ番号などの要素が含まれており、読者が文書をナビゲートして必要な情報を見つけるのに役立ちます。 技術文書はまた読者が容易にアクセスできる関連したセクションに情報を壊すためにヘッディングおよび小見出しの特定の構造に付着する。

これらは、テクニカルライターとして私たちが取り組んでいる側面のほんの一部です。 あなた自身の技術的な執筆技術を高めたいと思えば私達の技術的な執筆研修会を考慮しなさい。 それは1人か20人の必要性を満たすためにカスタマイズすることができます!

ドキュメントを自分で書きたくなく、経験豊富なテクニカルライターの支援が必要な場合は、サービスページをチェックしてください。

私たちは助けるためにここにいます。 今日私達に連絡して下さい!