テクニカルレポートを書くための基本ステップ

目次:

Anonim

あなたが新しい購入品を組み立てるか、または操作するためのマニュアルを読んだことがあり、あなたが始めたときより混乱して立ち去ったなら、あなたは一人ではありません。テクニカルライティングは、最も熟練したプロでさえ難しい場合があります。ただし、テクニカルレポートを作成するときは、適切な内容を含め、明確かつ簡潔にし、読者が理解しやすいように情報を整理することが重要です。

主題の選択

一般に、人々は何らかの研究を行った後にテクニカルレポートを作成し、その結果を特定のユーザーに提示する必要があります。この調査は実地調査 - 調査、インタビューおよび観察 - または本の調査であるかもしれません。行った調査の種類にかかわらず、収集したすべての情報を共有することはできません。ボルチモア郡メリーランド大学のAlan Sherman氏は、「テクニカルレポートの執筆についてのいくつかのアドバイス」で、あなたのレポートはあなたの研究の主題が興味深く重要であることを示す重要な発見に焦点を当てるべきであると示唆しています。必要に応じて、研究デザインや推奨事項などの要素も含める必要があります。

明確で簡潔であること

人々は、花言葉や画像に関する技術報告書を読むことはありません。代わりに、人々は特定の種類の情報を探しているので技術レポートを読みます。レポートを書くときは、明確かつ簡潔にしてください。あなたの聴衆と目的について考えて、あなたが伝えようとしていることを読者が最もよく理解できるように書くように書きなさい。たとえば、第二言語として英語を話す多くの人々があなたの報告を読むことを知っているならば、決まり文句や慣用句を避けてください。可能な場合はいつでも、あなたが集めた情報を報告する必要がない単語、文章、および段落を切り取ることに注意してください。

あなたの情報を整理する

組織はテクニカルレポートでは非常に重要です。ハウツー記事を書いているのか職場の会計報告書を書いているのかにかかわらず、整理されていない情報は読者がその情報を使用するのを難しくする可能性があります。対象読者と目的は、レポートの編成方法に大きく影響します。トピックについてあなたの聴衆がすでに知っていることは、あなたが詳細の前に背景情報を含める必要があるかどうかを決定します。あなたの報告の目的が金銭の使用を正当化すること、または取られるべき行動を提唱することである場合、提案または上訴で終了し、この行動に対するあなたの支持について報告の本文をまとめる。ハウツータイプの作品を書く人は、ステップが適切な年代順に並べられていることを確認する必要があります。

外部ソースを引用

情報技術報告書はしばしば研究結果を明らかにするので、あなたはあなたのテキストの中に他人の考えを引用しているかもしれません。あなたがこれらの情報源を引用しているか言い換えているかどうかにかかわらず、あなたはそれらを引用することによってそれらに信用を与える必要があります。あなたが仕事のためにあなたの報告を書いているならば、この引用のために脚注または文末脚注が推奨されるかもしれません。ただし、学校向けのレポートを作成している場合、教師または教授は通常、Modern Language AssociationまたはAmerican Psychological Associationスタイルなどの既存の引用スタイルを使用するように要求します。