Что такое техническое письмо? Полное руководство

Когда вам трудно разобраться с новым гаджетом, вы тянетесь за инструкцией.

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

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

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

По данным Glassdoor, технический писатель в компании SpaceX зарабатывает от $88,000 - $138,000 в год. 

Тем не менее, большинство людей до сих пор не понимают, что такое техническое письмо.

Это не просто набирает текст инструкции.

Это не просто перевод Переведите разговор инженеров на простой английский язык.

И дело даже не только в том. создание руководства пользователя или справочные документы. 

Что же такое техническое письмо? Чем оно отличается от других видов письма? Каковы его различные формы? Как стать техническим писателем? И как искусственный интеллект может помочь на этом пути? 

Обо всем этом - и о многом другом - мы расскажем в этом блоге. Давайте погрузимся! 

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

Говоря простым языком, техническое письмо означает, что нужно взять сложные и подробные темы и объяснить их так, чтобы любой человек (с соответствующим образованием) мог их понять. 

Например, это включает в себя:

• Руководства пользователя - Буклет, который прилагается к вашему телефону? Это техническое письмо.
• Документация API - Разработчикам тоже нужны инструкции. API сами себя не объясняют.
• Технические отчеты - Инженеры и ученые используют их для обмена исследованиями и результатами.

Техническое письмо - это не только то, что вы пишете, но и как вы это пишете. В нем используются:

• Императивное настроение - Вместо "Вы должны нажать на кнопку". просто "Нажмите на кнопку". 

• Пассивный голос (когда это необходимо) - Если неважно, кто совершил действие, пассивный залог поможет. "Файл был удален" работает лучше, чем "Кто-то удалил файл". если фокус находится на файле.

Некоторые люди считают, что техническое письмо - это только написание текстов для SaaS-продуктов или технических блогов. 

Но дело не в маркетинге и не в рассказе историй. 

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

Чем техническое письмо отличается от других стилей написания

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

Креативные писатели используют двусмысленность или метафоры, чтобы привлечь внимание аудитории. 

Технические писатели не стремятся к двусмысленности. 

Они хотят отдать предпочтение ясности, а не творческому самовыражению, но такова природа этой работы. 

Почему техническое письмо необходимо в различных отраслях промышленности

Представьте себе пилота, который читает это руководство во время полета, когда ему нужно срочно что-то понять:

"Отрегулировать вектор тяги для компенсации асимметричной двигательной аномалии путем применения протокола стандартного отклонения 5.3b с учетом переменных плотности атмосферы".

Представьте себе хирурга, который просматривает инструкции по проведению операции за мгновение до ее начала: 

"Делайте разрезы параллельно фасциальным плоскостям, учитывая расположенные ниже нервно-сосудистые структуры и поддерживая гемостаз на протяжении всей последовательности рассечения". 

Даже если они врачи или пилоты, которые изучали это всю свою карьеру, они не захотят читать это в чрезвычайной ситуации. 

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

Давайте рассмотрим пять основных причин, по которым техническое письмо является абсолютной необходимостью: 

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

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

3. Удовлетворенность клиентов и сокращение расходов на поддержку - Вы когда-нибудь пытались настроить новое устройство и в итоге смотрели случайный учебник на YouTube, потому что руководство не имело смысла? Плохая документация разочаровывает клиентов и нагружает службу поддержки ненужными звонками. Хорошо написанное руководство спасает от всего этого. 

4. Правовая защита - Контракты, правила и инструкции по безопасности служат доказательством в спорах.
   • Например, Если на компанию подают в суд за бракованный продукт, первое, что проверяют юристы, - это документацию. Предупреждали ли инструкции о рисках? Были ли четко прописаны процедуры безопасности? Если нет, то у компании проблемы.

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

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

Виды технического письма (с примерами)

Многие люди слышат "техническое письмо" и сразу же вспоминаются сухие, роботизированные руководства пользователя - такие, которые никто не читает, если только они совсем не завязли. 

Но техническое письмо - это нечто большее. 

На самом деле он существует практически в каждой отрасли и имеет множество различных форм, каждая из которых служит определенной цели.

Вот шесть наиболее важных типов технического письма (с примерами):

1. Техническая документация - Это классический тип. Он включает в себя руководства пользователя, руководства по продуктам и инструкции по устранению неполадок.  
   • Например, Вы только что купили совершенно новую эспрессо-машину, и вас озадачило множество кнопок. Вместо того чтобы гадать, вы открываете руководство пользователя и, следуя пошаговому руководству, готовите свою первую чашку.
     
2. Документация процесса - В каждой компании есть рабочие процессы, но если эти процессы существуют только в чьей-то голове, это катастрофа, которая только и ждет, чтобы случиться. Они называются СОПами. 
   • Например, Вы должны сделать фирменную закваску пекарни. Без СОПа каждая буханка будет отличаться от другой. К счастью, в SOP подробно описан каждый шаг - точные измерения, время подъема, температура выпечки - каждый раз.
     
3. Документация API - Если программное обеспечение - это мозг, API (Интерфейсы прикладного программирования) - это нервная система. 
   • Например, Приложение для поездок на автомобиле хочет получать данные о пробках в реальном времени, поэтому оно интегрирует API Google Maps. Без четкой документации по API они столкнулись бы с бесконечными пробами и ошибками.
     
4. Научные/исследовательские работы - Они пишутся исследователями, но должны быть доступны для чтения всему миру.  
   • Например, Новый метод лечения рака выглядит многообещающим, но прежде чем его использовать, ученые должны опубликовать данные о его действии, побочных эффектах и выживаемости. Другие исследователи проверяют данные, чтобы проверить их.
     
5. Белые книги и тематические исследования - Белые книги - это "убедительные аргументы" в техническом мире. Тематические исследования идут дальше, демонстрируя реальные истории успеха с фактическими результатами. 
   • Например, Компания, занимающаяся кибербезопасностью, в своем документе предупреждает о новой банковской угрозе. Месяц спустя они поделились примером того, как их инструмент остановил атаку. Банки начинают обращать на это внимание.
     
6. Нормативная/соответствующая документация - Здравоохранение, финансы и производство опираются на нормативные акты. Документы по соблюдению нормативных требований помогают компаниям следовать законам, избегая штрафов, судебных исков и общественных бедствий.
   • Например, Фармацевтическая компания должна доказать, что новое обезболивающее безопасно, прежде чем продавать его. Они представляют документы с указанием ингредиентов, дозировки и побочных эффектов, чтобы избежать любых юридических проблем.

Ключевые навыки, необходимые для написания технических текстов

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

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

• Исследовательские способности - Вам не нужно знать все, но вы должны уметь находить точную и достоверную информацию.
  
• Анализ аудитории - Знание того, кто ваши читатели, что они уже знают и что им нужно сделать, делает вашу статью полезной. Ведь то, как вы объясняете обновление программного обеспечения разработчику, совсем не то же самое, что вы объясните это клиенту.
  
• Навыки четкого общения/простого языка - Техническое письмо - это не умение казаться умным, а умение заставить других чувствовать себя умными. Это значит, что нужно отказаться от жаргона, использовать простой язык и писать так ясно, чтобы читателю не пришлось гадать, что вы имеете в виду.
  
• Информационная архитектура - Читатели не всегда читают от начала до конца, они сканируют. Вы должны понимать, как организовать контент с помощью заголовков, пулевых точек и логического потока, чтобы информацию было легко найти и переварить.
  
• Визуальная коммуникация - Иногда изображение объясняет что-то быстрее, чем абзац. Блок-схемы, аннотированные скриншоты и инфографика могут упростить даже самые запутанные концепции. Хороший технический писатель знает, когда нужно писать, а когда показывать.
  
• Владение инструментами - Знание правильных инструментов ускоряет процесс. Например, программы для работы с документацией - MadCap Flare или Confluence, а инструменты для проектирования - Snagit или Figma.

• Навыки редактирования и редактирования-Первый черновик никогда не бывает идеальным. Технические писатели должны дорабатывать свою работу, добиваясь ясности, точности и полноты, чтобы каждое слово служило цели. Речь идет о том, чтобы сделать документ максимально простым в использовании.

Кто использует техническое письмо? (Отрасли, которые в нем нуждаются)

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

Как стать техническим писателем 

Вот пошаговое руководство по работе в этой сфере:

Шаг # 1 - изучите основы

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

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

Пройдите курсы для начинающих и получите сертификаты по Coursera, Udemy, или Курс технического письма от Google. 

Следите за отраслевыми блогами, такими как  Напишите документы и STC (Общество технической коммуникации).

Шаг # 2 - Создание портфолио

Выберите продукт, которым вы пользуетесь ежедневно (например, кофеварку, фитнес-приложение или умную колонку), и напишите руководство пользователя или руководство по устранению неполадок. 

Это было бы идеально? Нет. 

Это даст вам что-то конкретное, что можно показать? Безусловно. 

Сообщество с открытым исходным кодом, например GitHub открыта для новых технических писателей. 

Многие проекты отчаянно нуждаются в помощи с документацией, и им неважно, новичок ли вы. 

Шаг # 3 - Получите должность начального уровня

Сосредоточьтесь на вакансиях со словами "младший" или "помощник" в названии на таких платформах, как LinkedIn, Действительно, и Мы работаем удаленно. 

Не упускайте из виду и контрактные позиции - их часто легче найти, и они могут привести к постоянным должностям.

Шаг # 4 - Продвижение по карьерной лестнице

Когда вы обретете уверенность и опыт, нацельтесь на должность старшего технического писателя, писателя API или UX-писателя.

Познакомьтесь с такими инструментами, как MadCap Flare, и Oxygen XML для структурированного письма или Уценка и Git если вы хотите работать с разработчиками. Но не обязательно осваивать все и сразу.

Шаг # 5 - Подготовка к собеседованию

• Часто задаваемые вопросы включают:
  • Как упростить сложную тему? → Покажите образец письма "до и после".
  • Какие инструменты вы использовали? Упомяните все.
  • Как вы справляетесь с обратной связью от инженеров? → Приведите реальный или гипотетический пример. 

Шаг # 6 - Продолжайте учиться и повышать свой уровень

Эта область постоянно развивается. В один год все говорят о вики, в другой - о документах как коде. 

Процветают те, кто продолжает повышать квалификацию. 

Следуйте за TechWhirl и Вишневый лист для трендов.

Начните сегодня. Перепишите инструкцию к продукту, выложите ее на LinkedIn и попросите оставить отзыв.

Инструменты и программное обеспечение для написания технических текстов

Инструменты искусственного интеллекта делают ваши задачи проще и эффективнее, и техническое письмо - не исключение.

Вот инструменты для технического письма, которыми пользуются профессионалы:

1. Для составления и редактирования контента:

1. MS Word позволяет создавать профессионально отформатированные документы с точным контролем над стилями, заголовками и перекрестными ссылками. 
2. Google Docs позволяет нескольким членам команды одновременно работать над одним документом. 

2. Для структурированной документации и публикации: 

1. MadCap Flare позволяет поддерживать единый источник контента, который автоматически публикуется в различных форматах. 
2. Adobe FrameMaker обработает вашу 500-страничную техническую спецификацию со сложными таблицами, специализированными диаграммами и перекрестными ссылками. 

3. Для командной документации:

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

4. Для управления и отслеживания изменений в документах:

1. GitHub позволяет разработчикам обновлять документацию одновременно с изменениями кода.
2. BitBucket интегрируется с вашим конвейером CI/CD, чтобы документация автоматически собиралась и развертывалась с каждым выпуском.

5. Для исследования, структурирования контента и улучшения читабельности:

1. Писатель эссе поможет вам документировать сложный алгоритм в соответствующем контексте, объяснениях и примерах. 
2. SEO-писатель гарантирует, что в вашей документации, предназначенной для публичного доступа, используется согласованная терминология и соблюдаются лучшие практики чтения. 
3. Чат с искусственным интеллектом поможет вашему техническому писателю упростить сложные концепции. Он предлагает альтернативные объяснения и выявляет области, в которых пользователям может понадобиться дополнительный контекст. 

Как искусственный интеллект может повысить эффективность написания технических текстов

Вот как искусственный интеллект может помочь вам в написании технических текстов: 

1. Автоматизация

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

Это сокращает время, необходимое для создания руководств, справочников и отчетов. 

Как это сделать...

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

Затем уточните язык, используя отраслевую терминологию, и проверьте содержание на достоверность. 

2. Грамматика и ясность

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

Вот как его использовать...

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

3. Структурирование контента

Хорошо структурированный документ предотвращает путаницу.

ИИ может логически организовать контент, группируя связанные темы, добавляя заголовки и предлагая макеты. 

Вот как его использовать.

Используйте наш Писатель эссе по искусственному интеллекту для создания отчетов, руководств и документации.

Заключение

Технические писатели переводят "язык инженеров" на "человеческий язык".

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

В нашем сложном мире очень важна четкая коммуникация.

Хорошее техническое письмо экономит время, деньги, разочарование, а иногда и жизни людей (в медицине и технике безопасности).

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

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

Если они понимают это, а не смотрят на вас остекленевшим взглядом, поздравляю!

Вы открыли для себя основной навык технического писателя: делать сложное простым.

Нужна дополнительная помощь? Необнаруживаемый ИИ Инструменты для совершенствования вашего письма и поддержания его в безупречном состоянии. Попробуйте их прямо сейчас!

Не стесняйтесь исследовать наш Детектор искусственного интеллекта и Humanizer в виджете ниже!