さまざまなテクニカルライティング標準とは何ですか？

テクニカルライティングは、特定の対象者、通常は対象となる主題について多くの知識を持つ個人を対象としています。 そのため、テクニカルライティングは通常、本質的に形式的であり、標準化された形式に従っています。 ライターは、ドキュメントの形式と目的を明確に把握し、この情報を作品の早い段階で明確に述べる必要があります。 ほとんどの技術文書は、次のコンポーネントを含む同様の構造形式に従います：要約または要約、目次、導入情報、背景情報、方法論の説明、結果に加えて分析情報、および付録。 特定のフォーマットの問題には、フォントの使用、ページ番号、および見出しと小見出しの使用も含まれる場合があります。 単語の選択は通常、対象となる聴衆によって決定されますが、すべてのテクニカルライティングの部分では明確さが非常に重要です。

準備作業により、テクニカルライティングの標準を強化できます。 実験室報告書から提案書に至るまで、いくつかの異なるタイプの技術文書が存在します。 テクニカルライターは、自分の目的に最も適したタイプを判断する必要があります。 さらに、作家は作品の明確な目的または目的を持ち、できるだけ早くこの情報を述べる必要があります。具体的な単語の選択、調子、形式のレベルは、主に対象読者によって決定されます。

大規模なテクニカルライティングドキュメントの場合、実際のテキストに大量の予備情報が必要になる場合があります。 通常、ドキュメント全体は、要約またはエグゼクティブサマリーと呼ばれる短いテキストにまとめられます。 この部分は、カバーされた主題の概要を提供する目次とともに、ドキュメントの最初に配置されます。

さらに、テクニカルライティングの標準では、ドキュメントの特定の構造形式がしばしばレイアウトされます。 情報はさまざまなセクションに分かれており、各セクションには見出しと可能な副見出しが含まれています。 一般的なテクニカルライティングドキュメントには、紹介、文献のレビューまたは背景、方法論、結果、意味または提案などのセクションが含まれます。 すべてのセクションは通常、第三者と現在形で書かれています。

テクニカルライティングは複雑な情報を使用し、研究を統合することが多いため、補足文書が頻繁に添付され、テキストが強化されます。 たとえば、チャートとグラフは、ポイントのサポートを提供し、複雑な情報をより明確にすることができます。 通常、この情報は付録の形式でドキュメントの最後に配置されます。 参照の手順は、本文の括弧内に記載されています。 外部の情報源を使用する場合は、これらを書き留めて参照セクションに配置する必要があります。

テクニカルライターは、特定の手法を使用して、情報を強調または区別します。 技術的な執筆基準が電子文書のメニューコマンドを暗くして太字にするように指示する場合など、単語またはフレーズの外観を変更することは1つのオプションです。 他の特定の情報も特殊なフォントを使用しています。 たとえば、本のタイトルはイタリック体であることが多く、頭字語は通常すべて大文字で書かれています。 特定の単語や見出しに注意を引くために、フォントサイズも変更できます。

読者の明快さは、技術的な執筆基準、および一般的な執筆基準において非常に重要です。 言語のレベルにもかかわらず、すべての情報は明確で理解しやすいものでなければなりません。 聴衆は技術用語に精通している可能性が高いため、これらの用語の説明は通常必要ありません。 文書は適切に流れ、情報を保持する適切な移行フレーズが必要です。 さらに、必要に応じてページに明確な番号とタイトルを付ける必要があります。

テクニカルライティングには、より具体的な形式の問題も数多くあります。 たとえば、略語は、略語が最初に使用されるとき、読者に対して常に完全に綴られる必要があります。 文書がリストを使用している場合、リストの各部分にある箇条書きと同様のフレーズ構造が一般的です。 一般に、10未満の数値のみを書き出す必要がありますが、測定単位は通常数値で書きます。 テクニカルライティングの対象読者は異なりますが、スラングや過度に非公式なライティングは避けてください。

テクニカルライティングの標準は、一般的な使用と専門家の承認によって広く受け入れられる可能性があります。 テクニカルライティングを専門とする教科書や雑誌は、通常、受け入れられている地域の基準を実装し、概説します。 プロのテクニカルライティングプログラムも必要なガイドラインを教えます。