Технический документ - это документ объемом от одной до пяти страниц, в котором описывается данная проблема и предлагается конкретное решение проблемы. Он обычно используется в правительственных и корпоративных учреждениях. В типичном техническом документе могут быть перечислены способы удовлетворения маркетинговых потребностей клиента, предложено использование определенного продукта для технического процесса или определены способы решения муниципальных проблем. Чтобы написать успешный технический документ, вы должны знать свою аудиторию, четко сформулировать проблему и привести убедительные и убедительные аргументы в пользу ее решения.
Шаги
Часть 1 из 3: Привлечение аудитории
Шаг 1. Определите свою аудиторию
Обычно вы не знаете свою аудиторию лично. Однако вы должны определить как можно больше факторов, таких как профессиональные потребности, уровень образования и должности. Эти аспекты определят, как сформулировать аргумент. Сформируйте свое предложение так, чтобы оно соответствовало вашей аудитории, основываясь на этих факторах.
Например, если ваша тема - общественные сады, обращайтесь к своим читателям как к владельцам собственности и родителям, а также к лицам, принимающим решения в сообществе. Им будет интересно узнать о влиянии садоводства и местной еды на их имущественные ценности, здоровье и образование детей
Шаг 2. Определите их уровень знаний
Так вы определите, насколько простой или сложной должна быть ваша работа. Если опыт вашей аудитории совпадает или близок к вашему, вы можете включить технический жаргон. Однако для широкой аудитории старайтесь, чтобы в статье не было жаргона. Если вам необходимо включить конкретную терминологию, используйте ее экономно и объясните. Например:
- Если вы пишете технический документ для инженера, вы должны включить много технических деталей и быть длинными в своих описаниях.
- Если вы пишете для государственного чиновника, сосредоточьтесь на последствиях, связанных с политикой.
- Если вы пишете для корпоративной аудитории, сосредоточьтесь на рентабельности и потенциале роста.
Шаг 3. Выберите броское название
Сделайте это привлекательным, но не чрезмерным. Упомяните или упомяните о своей проблеме. В некоторых заголовках есть слова «белая книга», но это не обязательно. Настройте язык для широкой аудитории. Вот несколько хороших примеров:
- Закрыв путь из школы в тюрьму с помощью искусства
- Более безопасные города через общественные сады: Белая книга
Шаг 4. Переходим к делу
Предположим, у вашего читателя очень насыщенная жизнь. Точно объясните, о чем ваш технический документ, не добавляя ненужных отступов. Сделайте свою первую пару предложений достаточно интересной, чтобы привлечь их внимание.
Шаг 5. Напишите введение
Признайте свою аудиторию и то, как вы собираетесь использовать статью. Обобщите нынешний порядок вещей и объясните, почему это проблема. Кратко обсудите аргументы вашей оппозиции и почему вы предлагаете нечто иное. Например, если вы писали о студенческой задолженности, вы могли бы сказать:
Студенческий долг за последнее десятилетие вырос в геометрической прогрессии. В сочетании с мрачным рынком труда, с которым сталкиваются новые выпускники, их долг грозит превратиться в следующий пузырь, который приведет к краху экономики. Кредиторы и ряд экономистов аргументировали это A, B и C. Однако эти аргументы не касаются X, Y и Z
Шаг 6. Обобщите свое решение
Кратко расскажите о методологии, которую вы будете использовать в своем анализе. Подробно опишите возможные решения, которые вы отклонили, и причины, по которым вы их отклонили. Объясните, почему ваша аудитория должна принять ваше предложенное решение. Например, решение проблемы пузыря студенческой задолженности может быть следующим:
После [опроса экспертов, изучения статистики и т. Д.] Я убедился, что [два или три предложенных решения] недостаточно решают проблему. В этом техническом документе приводится довод в пользу [предлагаемого вами решения], поскольку он [вставьте сюда объективную причину]
Счет
0 / 0
Часть 1 Викторина
Для какого технического документа вы хотели бы написать много технических терминов и очень подробных описаний?
Белая книга о необходимости для правительств штатов полностью финансировать программы продовольственных пособий.
Неа! Белая книга о политике будет ориентирована на политиков и НПО. Другими словами, люди без особых технических знаний. Избавьтесь от жаргона! Угадай еще раз!
Белая книга о том, как сократить расходы компании на человеческие ресурсы с помощью оффшорных подрядчиков.
Не совсем! Аудитория этого технического документа будет корпоративной, поэтому использование очень технической терминологии будет неуместным. Попробуйте использовать более удобный для бизнеса язык. Угадай еще раз!
Белая книга о том, как рост населения повлияет на жилую вместимость города.
Не совсем! Здесь нет необходимости в техническом жаргоне и очень подробных описаниях, потому что аудиторией будут правительственные чиновники НПО. Документ должен быть больше ориентирован на политику, чем на техническую информацию. Выберите другой ответ!
Белая книга о строительстве для расширения крупного столичного аэропорта.
Верно! Официальные документы для инженерной аудитории, вероятно, потребуют множества очень подробных описаний предлагаемой конструкции. Не бойтесь заходить слишком технически. Эта аудитория должна точно знать, как будет идти процесс строительства, от А до Я. Прочтите еще один вопрос викторины.
Хотите еще викторин?
Продолжайте проверять себя!
Часть 2 из 3: Обсуждение проблемы
Шаг 1. Определите проблему
На этом этапе вам нужно знать потребности вашего читателя. Сосредоточьтесь на задачах, которые вы предлагаете решить. Это должно быть что-то, что можно сформулировать в нескольких словах.
Примеры проблем включают «снижение продаж», «медленную скорость сети» или «конфликты между руководством и сотрудниками»
Шаг 2. Проанализируйте проблему
Это помогает сделать ваш аргумент убедительным в сознании читателя. Опишите проблему, которую вы выявили, более подробно. Опишите подробно, как вы пришли к выводу, что это проблема. Используйте ясные и точные термины. Ваш анализ не должен превышать одного абзаца.
Шаг 3. Предоставьте исторический обзор
Исторические обзоры помогают объяснить, как рассматриваемая проблема превратилась в проблему. Если возможно, вы также можете обсудить, как ваша проблема когда-то была решением. Используйте конкретные цифры, даты и имена, чтобы объяснить этот прогресс.
Например, в официальном документе по борьбе с изменением климата можно было бы обсудить, как когда-то считалось, что гидрофторуглероды (ГФУ) являются безопасной заменой хлорфторуглеродов (ХФУ), которые образовали дыру в озоновом слое. Однако теперь мы знаем, что ГФУ на самом деле опасные парниковые газы
Шаг 4. Используйте наглядные пособия
Включите диаграммы, графики или диаграммы, которые помогут подкрепить аргументы вашей белой книги. Они также могут привлечь внимание аудитории. Некоторые официальные документы включают наглядные пособия в текст. Другие помещают их в приложение в конце. Спросите своего работодателя, какой метод они предпочитают.
Шаг 5. Обеспечьте дополнительный фон
Проанализируйте представленные данные и цифры. Подробно опишите, как вы пришли к своим выводам. Убедитесь, что вы изучили все факты, чтобы в ваших выводах не было пробелов. Вы должны стремиться получить результаты, которые можно будет воспроизвести в ходе проведенного вами анализа. Счет
0 / 0
Часть 2 Викторина
Как использовать диаграммы и диаграммы, чтобы заинтересовать читателей?
Интегрируйте их прямо в текст.
Попробуйте снова! Да, диаграммы и диаграммы, интегрированные непосредственно в текст, могут помочь читателю понять информационный документ. Тем не менее, иногда есть более подходящие способы форматирования размещения наглядных пособий. Некоторые работодатели даже предпочитают вообще не использовать наглядные пособия! Выберите другой ответ!
Включите их в приложение в конце.
Не обязательно! Конечно, некоторые работодатели предпочитают, чтобы вы включали наглядные пособия только в приложение в конце. Тем не менее, некоторые могут предпочесть, чтобы они были представлены другим способом или вообще не представлялись! Есть лучший вариант!
Спросите своего работодателя, где следует размещать наглядные пособия.
Да! Наглядные пособия, такие как диаграммы, графики и диаграммы, могут быть полезным инструментом для подтверждения вашей правоты в вашем техническом документе. Иногда работодатели предпочитают, чтобы они были интегрированы непосредственно в текст, в то время как другие предпочитают их в приложении в конце. Некоторые работодатели предпочитают вообще не иметь наглядных пособий, поэтому сначала обязательно проконсультируйтесь с ними! Читайте еще один вопрос викторины.
Никогда не используйте наглядные пособия в белой бумаге.
Не совсем! Наглядные пособия могут быть весьма эффективными в официальных документах, если основная часть текста полностью проработана, а вспомогательные средства лишь дополняют друг друга. Тем не менее, есть случаи, когда наглядные пособия не подходят. Выберите другой ответ!
Хотите еще викторин?
Продолжайте проверять себя!
Часть 3 из 3: Обсуждение своего решения
Шаг 1. Опишите предлагаемые вами решения
Используйте пошаговый подход, который проясняет, как именно вы собираетесь реализовать свою идею. Разделите свой контент на удобоваримые части, такие как маркированные списки или отдельные абзацы с их собственными полужирными заголовками. Это поможет вашей аудитории прочитать и понять ваш аргумент.
Если вы пишете статью в корпоративном контексте, избегайте упоминания продукта вашей компании на этом этапе. Вместо этого сосредоточьтесь на том, чего ожидать от решения
Шаг 2. Обоснуйте свое решение
Используйте веские доказательства, такие как отраслевые журналы, правительственные публикации, а также данные и цифры в своем исследовании, чтобы объяснить, почему ваше решение является наилучшим способом действий. Взвесьте свой аргумент против других предлагаемых решений. Признайте полезность противоположных решений, подчеркнув, почему они не позволяют решить проблему.
Шаг 3. Завершите резюме
Включите обзор проблемы. Кратко изложите свое решение. Снова подчеркните результат, который вы надеетесь увидеть. Если вы решите добавить пробку для своего продукта или компании, сделайте это актуальным и незаметным. Помните, что вы сосредоточены на решении чужой проблемы, а не на продвижении продукта или услуги для личной выгоды. Счет
0 / 0
Часть 3 Викторина
Верно или неверно: аргументируя свое решение, вы должны избегать использования конкурирующих решений или противоположных точек зрения.
Правда
Не совсем! Предвидя критику и напрямую обращаясь к другим конкурирующим решениям, вы фактически укрепляете свои аргументы. Это показывает, что вы продумали весь спектр возможных действий и тщательно определили это решение как лучшее! Выберите другой ответ!
Ложь
Верный! Фактически вы укрепляете свои аргументы, когда активно отклоняете критику и напрямую обращаетесь к конкурирующим решениям. Это демонстрирует, что вы тщательно взвесили все возможные пути и долго обдумывали свое решение! Читайте еще один вопрос викторины.
Хотите еще викторин?
Продолжайте проверять себя!
Видео - с помощью этой службы некоторая информация может быть передана YouTube
подсказки
- Большинство официальных документов не содержат сносок или концевых сносок. Однако всегда полезно включать в конце полную библиографию. Уточните у своего работодателя, какой метод цитирования (Чикагское руководство, MLA, APA и т. Д.) Следует использовать.
- Если это ваш первый технический документ, поищите в Интернете примеры. Правительственные и корпоративные веб-сайты, а также академические базы данных полны официальных документов, ожидающих загрузки. Вы можете получить доступ к большинству этих ресурсов бесплатно.