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

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

準備作業は、テクニカルライティングの基準を高めることができます。ラボからの範囲のいくつかの異なるタイプのテクニカルライティングが存在します提案へのオラトリー報告。テクニカルライターは、どのタイプが自分の目的に最適かを決定する必要があります。さらに、作家は作品に対して明確な目的または目的を持ち、できるだけ早くこの情報を述べる必要があります。特定の単語の選択、トーン、および形式のレベルは、主に執筆のために意図した視聴者によって決定されます。

大規模なテクニカルライティング文書の場合、実際のテキストに伴う多くの予備情報が必要になる場合があります。全体的なドキュメントは、通常、抽象またはエグゼクティブサマリーとして知られる短いテキストにまとめられています。この作品は、文書の冒頭に配置され、対象の主題の概要を提供する目次とともに。

さらに、テクニカルライティングの基準は、多くの場合、ドキュメントの特定の構造形式をレイアウトします。情報は異なるセクションに分割され、各セクションは続きますAinsの見出しと可能なサブヘディング。典型的なテクニカルライティング文書には、以下のセクションが含まれる場合があります。紹介、文献レビューまたは背景、方法論、結果、および意味または提案。すべてのセクションは通常、第三者と現在の時制で書かれています。

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

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

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

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

テクニカルライティングの基準は、共通の使用と専門的な承認を通じて広範囲にわたる受け入れを獲得する可能性があります。テクニカルライティング専用の教科書とジャーナルは、通常、受け入れられた地域基準を実装および概説します。プロのテクニカルライティングプログラムは、必要なガイドラインも教えています。