Запросить демо

11 навыков хорошего техрайтера

09.06.2023

Кто такой технический писатель — знают все: тот, кто занимается технической документацией. Понятное руководство пользователя, простые пошаговые инструкции, полноценные справки, качественная API-документация, релиз-ноуты — только часть того, над чем трудятся эти специалисты. 

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

Образование

К сожалению, в ВУЗах России пока еще нет отдельных факультетов и кафедр технического писательства как такового. Чаще всего в профессию приходят представители смежных технических направлений — мехмат, информационная безопасность, математическое обеспечение и администрирование информационных систем, а также таких гуманитарных сфер, как филология, перевод и переводоведение, интеллектуальные системы в гуманитарной среде.

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

Интерес к науке и технике

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

Навыки письма

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

Навыки корректуры

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

Системность и последовательность

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

Опыт применения профессиональных инструментов

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

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

Понимание принципа единого источника

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

Основы веб-дизайна

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

Работа в команде

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

Понимание аудитории

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

Подход к подаче одной и той же информации будет одним для аудитории B2C и другим — для B2B. Для одного стоит использовать более простые термины, для другого можно смело пользоваться профессиональной лексикой. И для того, чтобы понимать это, нужно понимать, как мыслит та или иная аудитория, и подбирать наиболее подходящий формат для ответа на ее запрос. 

Критическое мышление 

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

Здравый смысл

Собственно, без него не обойтись в любой профессии.

* * *

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

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

Обновление платформы!
AI-возможности и новый редактор главной страницы доступны уже сейчас.