16 советов по техническому письму |

19 марта 2021 г.

Техническое письмо — это ценный навык, полезный для всех, кто работает в технической области, поскольку он включает в себя сбор сложной информации и упрощение ее восприятия и понимания. Это востребованный навык среди компаний, и ожидается, что спрос на него будет продолжать расти. Независимо от того, работаете ли вы техническим писателем или просто выполняете техническое письмо для своего отдела, просмотр списка советов по техническому письму может помочь вам улучшить свои навыки.

В этой статье мы обсудим, что такое техническое письмо, и предложим список из 16 различных советов, которые вы можете использовать, чтобы улучшить свои навыки письма.

Что такое техническое письмо?

Техническое письмо — это стиль письма, который включает в себя описание деталей высокого уровня и их объяснение в понятной и понятной форме. Этот стиль письма часто встречается в профессиональных и технических областях. Техническое письмо обычно включает в себя общение на технические темы, общение с использованием таких технологий, как социальные сети или веб-страницы, или предоставление инструкций о том, как что-то делать.

Советы по техническому письму

Вот 16 советов, которые помогут вам улучшить свои навыки технического письма:

1. Определите свой проект

Один из первых шагов, которые необходимо предпринять при создании любого технического документа, — определить свой проект. Например, вам нужно определить свою основную цель с документом и понять стилистические требования. Этот шаг имеет решающее значение, поскольку он определяет язык, который вы используете, тип информации, которую вы включаете, и даже то, как вы организуете контент.

2. Проанализируйте свою аудиторию

Важным компонентом хорошего технического письма является уверенность в том, что вы пишете для конкретной аудитории. Начните процесс написания, проанализировав свою аудиторию и получив общее представление о том, кто будет читать документ.

3. Создайте образ для своего читателя

После того, как вы точно определите, кто является этой аудиторией, вы можете дополнительно уточнить ее, создав личность для своего читателя. Создание персоны — простая задача, если вы пишете документ для конкретного человека в вашей компании, например, для вашего менеджера. Однако, если вы этого не сделаете, вы можете создать вымышленного человека, назначив ему определенный пол, возраст, образование и историю о том, почему он нуждается в документе и читает его. Вы также должны спросить себя, что ищет читатель, когда он читает ваш документ, какую информацию он ожидает найти.

4. Используйте простой язык

Техническое письмо должно быть простым и понятным. Когда вы пишете технический документ, используйте простой, прямой язык, который может передать ваше сообщение максимально четко и лаконично.

5. Поймите содержание

Чтобы четко передать свое сообщение, важно иметь глубокое понимание темы, о которой вы пишете. Вы должны быть в состоянии предвидеть вопросы, которые могут возникнуть у вашей аудитории по этому вопросу, и дать подробное объяснение, которое ответит на них.

6. Создайте схему

Прежде чем вы начнете процесс написания документа, вы должны начать с создания плана. Это поможет вам продумать содержание и то, что вы хотите включить, а также гарантирует, что оно организовано функциональным и логичным образом.

7. Учитывайте структуру

Важно структурировать информацию в вашем документе тематическим и логичным образом. Например, если кто-то читает ваш документ, чтобы найти решение проблемы, у вашего руководства должен быть список задач, которые они должны выполнить, чтобы решить эту проблему.

Их также следует сгруппировать тематически, чтобы, если одна задача не сработала, они могли естественным образом перейти к следующей. Кроме того, весь документ должен быть естественным, так как некоторые из ваших читателей, скорее всего, прочитают документ полностью, от начала до конца.

8. Включите примеры

Хотя вы всегда должны использовать детали при объяснении своей темы, вы также должны включать примеры, которые помогут прояснить то, что вы обсуждаете. В идеале примеры, которые вы приводите, должны представлять реалистичный сценарий, с которым может столкнуться читатель. Например, если вы пишете руководство для какого-либо оборудования, вы можете описать читателю, как оно должно выглядеть и ощущаться, если часть находится в правильном положении, или каковы признаки того, что она может работать со сбоями.

9. Добавьте изображения

Наглядные материалы могут быть чрезвычайно полезными, помогая читателям понять, как правильно выполнять задачу. Это также полезно для объяснения статистической информации. Тем не менее, важно по-прежнему использовать подробные описания в своем письме и не слишком полагаться на визуальные эффекты для объяснения темы.

10. Пишите вне времени

В зависимости от характера вашего документа может потребоваться его периодическое обновление. Тем не менее, вы должны сосредоточиться на том, чтобы сделать ваше письмо как можно более вневременным. Если вам нужно поделиться информацией, которая носит временный характер или зависит от времени, объясните текущий контекст для людей, которые будут читать ее в будущем. В идеале документ должен быть таким же точным и актуальным сейчас, как и через годы.

11. Используйте количество слов в качестве общего руководства

Поскольку техническое письмо должно быть прямым и кратким, важно передать свое сообщение как можно меньшим количеством слов, оставаясь при этом описательным и подробным. Хотя отслеживание количества слов может быть полезным в качестве общего руководства, вам следует больше сосредоточиться на том, чтобы инструкции были максимально эффективными для читателя. Это означает, что информация может быть передана всего в 500 словах или в 10 000 слов.

12. Используйте подходящий голос

Важно создать соответствующий голос в вашем техническом письме. В большинстве случаев голос должен быть формальным и объективным. Однако он также должен легко читаться. Помните о своей целевой аудитории, когда выбираете наиболее подходящий голос для своего документа.

13. Сделайте документ доступным для поиска

Если у вас есть длинный документ, важно включить оглавление, чтобы сделать его более удобным для поиска вашими читателями. Оглавление должно состоять из списка задач, которые вы включаете в документ или руководство. Вы также можете подумать о создании указателя, если руководство особенно длинное. Ваш индекс, если вы его включаете, должен содержать список ключевых слов и терминов, а также страницы, к которым читатели могут обращаться по этим темам.

14. Используйте глобальный английский

Global English — это буквальный и понятный стиль английского языка. Когда вы пишете, обращайте внимание на слова и фразы, которые вы используете. Избегайте идиом, которые могут быть неправильно поняты, и будьте осторожны при использовании слов, которые могут быть как глаголом, так и существительным. Например, слово «руководство» может быть как существительным, так и глаголом.

15. Укажите свои источники

Сильное техническое письмо включает в себя внешние источники, такие как статистика и информация из исследований. Важно правильно и точно цитировать все источники.

16. Тщательно пересматривайте

Когда закончите, важно тщательно вычитывать и редактировать текст. После завершения первого черновика дайте себе некоторое время, прежде чем приступить к редактированию и пересмотру. Это облегчит чтение вашего письма с более критической точки зрения. Подумайте, есть ли разделы вашего письма, которые можно было бы расширить, или области, которые вы могли бы сделать более краткими.