Skip to main content

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

deminalテクニカルライティングは、特定の視聴者を対象としています。通常、意図した主題について多くの知識を持っている個人です。そのため、テクニカルライティングのピースは通常、本質的に正式であり、標準化された形式に従います。作家は、ドキュメントの形式と目的を明確に把握し、この情報を作品の早い段階で明確に述べる必要があります。ほとんどの技術文書は、次のコンポーネントを含む同様の構造形式に従います:要約または要約、目次、紹介情報、背景情報、方法論の説明、結果と分析情報、付録。特定のフォーマットの問題は、フォントの使用、ページ番号、および見出しとサブヘディングの使用も含まれる場合があります。通常、単語の選択は対象となる視聴者によって決定されますが、すべてのテクニカルライティングのピースでは明確さが重要です。interation準備作業は、テクニカルライティングの基準を高めることができます。実験室の報告から提案に至るまで、いくつかの異なるタイプのテクニカルライティングが存在します。テクニカルライターは、どのタイプが自分の目的に最適かを決定する必要があります。さらに、作家は作品に対して明確な目的または目的を持ち、この情報をできるだけ早く述べる必要があります。特定の単語の選択、トーン、形式のレベルは、主に執筆のために意図した視聴者によって決定されます。文書を書くと、実際のテキストに伴う多くの予備情報が必要になる場合があります。全体的なドキュメントは、通常、抽象またはエグゼクティブサマリーとして知られる短いテキストにまとめられています。この記事は、文書の冒頭に配置され、対象の主題の概要を提供する目次とともに、テクニカルライティングの基準がドキュメントの特定の構造形式をレイアウトすることがよくあります。情報は異なるセクションに分割され、各セクションには見出しと可能なサブヘディングが含まれています。典型的なテクニカルライティング文書には、以下のセクションが含まれる場合があります。紹介、文献レビューまたは背景、方法論、結果、および意味または提案。すべてのセクションは通常、第三者と現在の時制で書かれています。たとえば、チャートやグラフは、ポイントをサポートし、複雑な情報をより明確にすることができます。一般に、この情報は、付録の形式でドキュメントの最後に配置されます。参照の手順は、テキストの括弧内に配置されます。外部のソースを使用する場合は、これらに注意して参照セクションに配置する必要があります。単語またはフレーズの外観を変更することは、テクニカルライティングの基準が電子文書のメニューコマンドが暗くなって太字であることを決定する場合など、1つのオプションです。他の特定の情報も特別なフォントを使用しています。たとえば、本のタイトルは多くの場合斜体に配置され、頭字語は通常、すべての大文字で書かれています。特定の単語や見出しに注意を引くために、フォントサイズも変更される場合があります。一般的に執筆基準。言語のレベルにもかかわらず、すべての情報は明確で理解しやすい必要があります。聴衆は技術用語に精通している可能性が高いため、これらの用語の説明は通常必要ありません。ドキュメントは適切に流れる必要があり、適切な移行句が情報をまとめて保持しています。さらに、必要に応じてページには明確に番号付けされ、タイトルを付けます。たとえば、略語が最初に使用される場合、略語は読者のために常に完全に綴らなければなりません。ドキュメントが使用する場合sリスト、次に、リストの各部分の弾丸ポイント、および同様のフレーズ構造が典型的です。一般に、10未満の数のみが書き出す必要がありますが、測定単位は通常数値的に記述されます。テクニカルライティングの視聴者は異なりますが、スラングまたは過度に非公式の執筆を避ける必要があります。dechany技術執筆基準は、共通の使用と専門的な承認を通じて広範囲にわたる受け入れを得る場合があります。テクニカルライティング専用の教科書とジャーナルは、通常、受け入れられた地域基準を実装および概説します。プロのテクニカルライティングプログラムも必要なガイドラインを教えています。