Инженеры, ученые и медицинские работники тоже должны быть хорошими писателями - и технические отчеты подтверждают это! Хороший технический отчет представляет данные и анализ по указанной теме в ясной, высокоорганизованной и эффективной форме. Прежде чем начать писать, определите свое сообщение и аудиторию, а также сделайте набросок. Затем напишите основную часть отчета и окружите ее другими необходимыми разделами в соответствии с выбранным макетом.
Шаги
Часть 1 из 3: Планирование вашего отчета
Шаг 1. Определите сообщение, которое вы хотите передать в отчете
Вы провели исследование и собрали данные, так что теперь пора спросить себя, что все это значит. Как вы определите проблему или тему, которыми вы занимаетесь, и какие выводы вы можете сделать на основе данных и свидетельств?
- Например, вы можете заявить, что новый метод извлечения определенного химического соединения более безопасен и экономичен.
- Лучшие технические отчеты остаются ясными и целенаправленными - они имеют конкретную цель и передают информацию в логическом порядке.
- Работайте с консультантами, руководителями или коллегами, чтобы уточнить сообщение и / или цель вашего отчета. Они могут сильно различаться в зависимости от того, создается ли отчет для академических, деловых или других целей.
Шаг 2. Определите свою аудиторию, прежде чем начать писать
Кто будет читать ваш отчет: коллеги-исследователи, руководители корпораций, широкая публика или кто-то еще? Совершенно необходимо, чтобы ваш отчет был составлен таким образом, чтобы его данные и выводы могли быть легко поняты целевой аудиторией.
- Если отчет будут читать другие в вашей области, он может быть более «техническим» по языку и деталям. Однако во многих случаях технические отчеты предназначены для тех, кто не относится к вашей конкретной дисциплине. Если это так, сократите жаргон для неспециалистов.
- Подумайте о том, чтобы неопытный друг просматривал ваш отчет на протяжении всего процесса, чтобы высказать свое мнение о его доступности для широкой аудитории.
Шаг 3. Создайте план, которому будете следовать во время письма
Технические отчеты обычно очень структурированы, часто с четко обозначенными и пронумерованными разделами. Таким образом, довольно просто составить схему, определяющую каждый из основных элементов отчета.
Определите, какие именно разделы ваш отчет должен или может содержать. Проконсультируйтесь с человеком или организацией, которым вы будете отправлять отчет, относительно каких-либо требований к макету
Часть 2 из 3: Написание основной части отчета
Шаг 1. Составьте подробное, но целенаправленное введение в отчет
Во введении к техническому отчету излагается основная проблема или проблема, к которой относится ваш документ, и то, как вы подходите к ее решению в отчете. Он должен указать читателю, почему рассматриваемая проблема важна, и четко определить цели вашего отчета.
- В большинстве случаев введение, вероятно, будет состоять из 1-3 абзацев.
- В конце введения должно быть четко указано, что «делает» отчет. Это может быть сделано посредством прямого заявления («В этом отчете анализируется…») или путем предоставления ряда вопросов (которые в некоторых случаях могут быть помечены или пронумерованы) для ответа.
Шаг 2. Предоставьте исходную информацию и / или обзор литературы в следующем разделе
Сразу после вступления погрузитесь в основные обстоятельства, связанные с обсуждаемой темой - например, краткую историю проблемы и ее актуальность сегодня. Если эта тема постоянно обсуждалась в вашей области, вы также можете познакомить читателей с важными примерами прошлых работ по этой теме.
По сути, вы хотите, чтобы читатели, которые могут быть новичками в предмете, после прочтения этого раздела почувствовали, что они хотя бы элементарно разбираются в нем
Шаг 3. Затем дайте четкое и подробное описание проекта
В этом разделе вы в основном рассказываете своему читателю, что вы на самом деле сделали, чтобы решить возникшую проблему или проблему. Сообщите им, какой тип тестирования или анализа вы проводили, с помощью каких методов и оборудования, а также любые другие важные детали.
- Если, например, ваш отчет посвящен определенному эксперименту, укажите, как он был задуман, настроен и проведен.
- Иногда это называется разделом «методы», поскольку вы описываете методы, используемые для проведения вашего исследования.
Шаг 4. Представьте свои данные и опишите, что все это означает, в следующих разделах
Теперь вы подошли к сути технического отчета, в котором вы четко изложили и контекстуализировали собранные данные. В большинстве случаев вам потребуется предоставить множество рисунков и таблиц для представления фактических данных. Не полагайтесь исключительно на них, хотя используйте текст, чтобы поместить результаты в контекст, подходящий для вашей целевой аудитории.
- Может быть сложно определить, сколько данных представить. Слишком мало может значительно ослабить ваш анализ и общий отчет. Однако, отдавая слишком много, читатель может утонуть в море таблиц и цифр. Убедитесь, что вы предоставили все важные данные, и ошибитесь, если предоставите слишком много, если не указано иное.
- Представьте свои данные в логическом порядке, чтобы каждая таблица или рисунок переходили в следующую.
Шаг 5. Завершите отчет заключением, которым завершается ваше введение
В техническом отчете ваше введение должно поднимать «большие» вопросы, а ваше заключение должно содержать ваши ответы. Если, например, вы указали несколько конкретных вопросов во вступлении, ответьте на них конкретно в заключении. В противном случае используйте его, чтобы свести воедино свои выводы в четкое и убедительное заявление.
Делайте выводы настолько смелыми, насколько позволяют ваши данные и анализ. Не используйте такие термины, как «мог бы», «возможно», «мог бы» и т. Д. - напишите что-нибудь вроде «Данные показывают, что…». Однако не делайте выводов, которые не подтверждаются вашими данными
Часть 3 из 3: Добавление компонентов в правильный макет
Шаг 1. Узнайте о конкретных рекомендациях в своем университете, у работодателя и т. Д
Хотя когда дело доходит до организации технических отчетов, существует изрядная степень стандартизации, конкретный макет может несколько отличаться в зависимости от дисциплины или других факторов. Например, следующий макет является довольно стандартным, который может быть использован в вашем конкретном случае:
- Титульная страница
- Абстрактный
- Управляющее резюме
- Оглавление
- Список рисунков / Список таблиц
- Основной отчет: Введение; Предпосылки / Обзор литературы; Описание Проекта; Данные / Описание данных; Заключение
- Благодарности
- использованная литература
- Приложения
Шаг 2. Создайте простую титульную страницу в начале вашего отчета
Титульный лист, очевидно, должен содержать название отчета и ваше имя, и часто включает такие детали, как дата и цель представления отчета. Ознакомьтесь с рекомендациями по макету титульного листа для вашей дисциплины, отдела, работодателя и т. Д.
Типичный титульный лист (и общий макет отчета) см. На странице
Шаг 3. Дайте краткий обзор отчета в виде аннотации
Цель аннотации к техническому отчету - изложить суть отчета примерно в 300 слов. Вам необходимо очень быстро изложить, что охватывает отчет, а также любые выводы или рекомендации, которые вы в нем делаете.
- Напишите тезисы после того, как вы напишете сам отчет. Вы хотите, чтобы это было сжатое описание того, что вы написали, а не того, что вы собираетесь писать.
- Проверьте, есть ли ограничение по количеству слов для вашего резюме. Даже если нет, 300 слов - это хороший предел, к которому нужно стремиться.
Шаг 4. Создайте краткое изложение, которое сокращает отчет примерно на 90%
Резюме получили свое название из-за того, что они нацелены на высокопоставленных руководителей, у которых, вероятно, не будет времени прочитать весь отчет. Исполнительный отчет должен быть длиннее и детальнее, чем реферат, но при этом составлять лишь около 10% от объема основного отчета.
- Резюме должно быть сосредоточено на ваших выводах, выводах и / или рекомендациях и позволять самому отчету представлять данные, хотя должны быть представлены основные данные.
- В зависимости от вашей ситуации вам может потребоваться написать реферат, резюме или и то, и другое.
Шаг 5. Составьте оглавление, список таблиц и список рисунков
Оглавление должно разбивать весь отчет по разделам, чтобы читатели могли быстро прочувствовать весь отчет и найти любой конкретный раздел. Технические отчеты основаны на данных и неизменно содержат множество таблиц и рисунков, поэтому предоставьте их списки, чтобы быстро их идентифицировать и дать читателям знать, где их найти.
Ознакомьтесь с рекомендациями по форматированию для этих разделов. Если формат оставлен на ваше усмотрение, делайте все просто и понятно
Шаг 6. После основной части отчета добавьте раздел с благодарностями
В то время как разделы с благодарностями в книгах или других типах исследовательских работ часто выражают благодарность друзьям и семье, в технических отчетах они обычно сосредоточены на упоминании тех, кто непосредственно помогал облегчить создание отчета. По сути, в этом разделе следует отметить любого человека или группу, которые поддерживали вашу работу на профессиональном уровне (в том числе финансово, например, посредством грантов).
Этот раздел обычно состоит из 1-2 абзацев и соответствует довольно простому формату «Автор хотел бы поблагодарить…»
Шаг 7. Включите цитаты в раздел ссылок, используя согласованный формат
Создайте ссылку на каждый источник, из которого вы цитируете или на который ссылаетесь в основной части отчета. Если вам не указан конкретный формат цитирования (например, формат APA или MLA), выберите один и последовательно следуйте ему в этом разделе и во всем отчете.
В некоторых случаях от вас также могут потребоваться перечисление работ, с которыми вы консультировались, но которые специально не цитировались в работе. Если вы не уверены, обратитесь к соответствующему отделу, организации, сотруднику и т. Д
Шаг 8. Используйте приложения для предоставления полезной, но не важной информации
Если, например, у вас есть много необработанных данных, которые сами по себе не важны для отчета, но, тем не менее, поучительны, включите их в одно или несколько приложений. Никогда не помещайте в приложение то, что вы считаете важным для отчета - найдите для этого место в основной части работы.