テクニカルライティングとは、文書やビジュアル、口頭情報、デモンストレーションを教育訓練資料に処 テクニカルライティングの目的は、プロセスを説明したり、特定の聴衆のために理解しやすく複雑な概念を作る材料を提供することです。 効率的かつ効果的な技術的な執筆を通じて、作家は情報を理解し、特定のタスクを達成する方法を説明し、読者を支援することができるようになりま 技術的な執筆には5つの普遍的な倫理原則があります。 原則は、質の高いコンテンツ、視聴者と目的、アクセシビリティ、文法、および文体です。
質の高いコンテンツ
質の高いコンテンツは主観的なものです。 MATCの高品質コンテンツの定義は、クライアントの基準を満たしているか、プロジェクトの最初の範囲を超えている製品です。 良質のプロジェクトを作り出すためには、心の意図されていた聴衆と書く必要がある。 作家は文書か材料が完了する前に必要とされる付加的な知識を研究しなければならない。 ライターは、情報を表現するためにどの形式またはプラットフォームが使用されるかを知る必要があります。 作家は、期限が何であるかを知ることから、情報を書く必要がある理由を知ることまでの範囲の特定の情報を決定する必要があります。
観客と目的
優れた技術的な作品を作るためには、作家は目的と観客の両方を理解する必要があります。 技術的な執筆聴衆は企業および特定の顧客で変わる。 例えば、ラップレポートの聴衆は作家として私達を雇ったプロダクト製造である。 Eラーニングトレーニングモジュールのための聴衆は、コンプライアンストレーニングを必要とする銀行や住宅ローンの提供者であってもよいです。 作家は、読者が知っているだろうどのくらい知っているし、それは読者に通信することになると作家が果たすために必要とされる責任を知ってい
アクセシビリティ
視聴者がライターが作成した情報に簡単にアクセスできることが不可欠です。 アクセシビリティには、ヘッダーやフッターなどのドキュメント上のもの、またはコンピュータiLearnモジュール上のものが含まれています。 テクニカルライターは、読者が参考文献からページ番号、目次への表記でドキュメントをナビゲートするのに役立つ最良の方法を理解する必要があります。 作家は、さらに情報を説明するために、チャートや図などのビジュアルを追加することさえできます。
文法
文法を適切に使用して、明確で簡潔で簡単に書くことは、技術的な部分を書く上で不可欠です。 作家はまた文法、様式およびレイアウトの間違いか矛盾を訂正するために書かれている技術的な部分を校正し、編集しなければならない。 テクニカルライターは、クライアントが他の賢明な自分の好みを示していない限り、常に現在時制で書く必要があります。 技術的な部分の読者は指示をのための与えているものを丁度するべきである。 作家は常に性別中立名詞を含む簡単な文章で書くべきです。 簡単な文章は、読者が明確かつ効率的に彼らの目標を完了するために着手しなければならないタスクを理解するのに役立ちます。
文章のスタイル
文章のスタイルは、観客が誰であるか、技術的な作品が書かれているシナリオに大きく依存するため、すべての技術的な作品で異 技術的な執筆部分の調子はどのような調子が仕事を完了するために要求されるか読者が理解するのを助けるので必要である。 単語の選択はまたあなたの聴衆がだれであるかに接続するので助力の様式の必要性を提供する聴衆のための必要性の必要な部分である。 情報やウェブサイトのセクションを参照する際には、図や表などのツールを使用して情報にアクセスするための明確で目に見える方法を提供する
その他の技術的な執筆のヒント
余分な研究を行い、詳細を学ぶ
最低限を知ることは、聴衆が情報を理解するのに役立つ最高の技術的な部分を得 作家と読者の両方が理解していないかもしれない多くの用語があるかもしれません。 経験則として、読者が概念や用語を理解していない場合は、それを定義してください。 あまりにも多くの情報は、常に後のレビューで削減することができます。 この情報は、作家が全体として書いているものとどのように機能するかを理解するために研究する必要があります。 小さな父親を研究し、書かれている技術的な部分を強化するために他の情報を使用することができるかを調べます。
観客になり、観客を過小評価する
観客の靴に身を置く。 あなたは明らかに理解し、あなたが聴衆のために書かれた指示や情報に従うことができますか？ はいの場合は、もう少し助けが必要だと思う場合は、より多くの情報を提供できます。 そうでない場合は、明確ではない部分を見つけて、情報を適切に提供する方法を見つける必要があります。 テクニカルライターが頻繁に持っている大きな問題は、彼らが彼らの聴衆の知識を過大評価することです。 聴衆は知識の異なったレベルの多数の人々であることができます。 聴衆のための復習として仮定されるか、または既に述べられることができる情報を簡潔に提供することは完全に受諾可能である。
第二および第三の意見とピアレビューを求める
テクニカルライターは機知に富んでいます。 あなたが持っている最も大きい資源はあなたの主題の専門家である。 彼らは任意の知識のギャップやエラーが表示された場合、あなたの中小企業に尋ねることを確認してください。 作家は作家が見落とすかもしれない間違いか知識のギャップがあるかどうか見るために彼らの顧客と点検する。 監督者や同僚を見て意見を述べることは、技術的な部分を強化するのにも役立ちます。 ピアレビューは、人々のグループが読んで、上のコメント、およびお互いの仕事の改善をお勧めするために会うときです。 より多くの人々が正確で、簡潔な情報を保障する文書を見直すときより多くの盲点は覆いを取られるようになる。
テクニカルライターは、彼らが取り組んでいるすべてのプロジェクトのための新しい情報を学びます。 作家は主題の専門家とのすべての研究そして議論の前に読者の知識のレベルの下で始まるので顧客が必要とするものをのよりよい理解を得る。 より少ない仮定がより有効な訓練のために開くのでこれは会社に大きい資産になる。 材料を学ぶ作家と技術的な執筆基準のこれらの倫理的原則の組み合わせは、より自信を持って効率的な従業員につながります。