Помните времена, когда на собеседовании в IT-компанию достаточно было блеснуть знанием русского языка и уверенно рассказывать о стилях и структуре текста, а на вопросы о Git или API можно было пожимать плечами? Забудьте. Сегодня «писать красиво» уже считается базовой нормой. Современный технический писатель — это полноценный член команды, который понимает, как работает продукт, как его разрабатывают и как он доходит до конечного пользователя. А это значит, что пора осваивать новые горизонты: от Docs-as-Code и API до UX и легкого DevOps.
Современные требования к техническому писателю
Техническое писательство сегодня — это сочетание сильных писательских навыков и базовых технических знаний, характерных для IT-специалистов. Важно понимать язык разработчиков, уметь самостоятельно находить пробелы в знаниях и переводить технический контент на доступный язык. Стиль письма должен быть лаконичным и точным, учитывая аудиторию: что она уже знает и что необходимо объяснить.
Большинство текстов создаётся с помощью инструментов вроде Jira и Confluence. Современный технический писатель объединяет множество процессов — DevOps, Agile/Scrum, Kanban — с базовым пониманием технологий программирования, таких как JavaScript, XML, IT-сети и облачные сервисы. Также важно уметь работать с системами управления исходным кодом, например, Git.
Docs-as-Code становится стандартом отрасли. Писатели используют те же инструменты, что и разработчики, и должны уметь различать содержание документа и его форматирование, создавать текстовые файлы с базовым форматированием и разметкой.
На рынке труда требования к новичкам и опытным специалистам часто включают:
- Markdown
- MadCap Flare/Confluence
- DITA/XML / структурированный авторинг (Structured authoring)
- GitHub
- Документацию API
Особое внимание стоит уделить документации API: этот навык повышает конкурентоспособность и открывает множество возможностей для трудоустройства.
Дополнительно полезно изучить базовые языки программирования, такие как Python, C# или JavaScript (например, React). Это помогает работать с документацией для разработчиков и соответствует ожиданиям работодателей.
Markdown и GitHub легко освоить и их изучение не требует больших затрат. Знакомство с MadCap Flare полезно, если компания им активно пользуется — основы легко освоить, а более сложные функции приходят с опытом.
Новый скиллсет технического писателя
В современном IT-мире недостаточно просто хорошо писать. Технический писатель должен разбираться в технологиях, понимать принципы разработки и быть готовым к постоянному обучению. Рассмотрим ключевые навыки техписа 2.0.
1. Docs-as-Code: добро пожаловать в мир разработки
Docs-as-Code — это подход, при котором документация живёт по тем же правилам, что и код: контроль версий, ревью и автоматизация. Он не подходит всем: некоторые команды успешно ведут документацию в Confluence. Но для сложных продуктов с постоянными обновлениями этот подход позволяет поддерживать актуальность и качество документов. Git, CI/CD и pull requests становятся не просто плюсами в резюме, а инструментами для эффективной работы с документацией.
2. Markdown: хорошо, но мало
Markdown удобен для большинства задач и поддерживается платформами, но имеет ограничения при создании сложных таблиц и нестандартных элементов. Важно понимать его границы и при необходимости использовать альтернативы, такие как AsciiDoc или Org-mode, чтобы создавать более структурированную и гибкую документацию.
3. API: говорим на одном языке с разработчиками
API – это сердце любого современного приложения. Документация API — ключевой навык для современных техписов. Не обязательно быть программистом, но важно понимать структуру запросов и ответов, адаптировать сложные технические концепции для разных аудиторий, особенно в B2B SaaS.
4. UX: документация как часть интерфейса
Технический писатель часто взаимодействует с интерфейсами. Задача — сделать интерфейс интуитивным и помочь пользователю разобраться в продукте без лишних усилий. Участие в обсуждениях UX, предложения по подписям к элементам интерфейса и обратная связь дизайнерам делают документацию более полезной.
5. Легкий DevOps: документация в облаках
Документация — это часть продукта, она должна жить в репозитории, проходить через CI/CD и автоматически публиковаться. Понимание инфраструктуры публикации, работы пайплайна и версий позволяет создавать актуальную документацию и интегрировать её в процессы разработки.
Чек-лист навыков современного технического писателя
Сегодня ключевые навыки техписа включают работу с различными инструментами и системами:
- WYSIWYG — умение создавать и редактировать документы через визуальный интерфейс, работать с заголовками, форматированием, комментариями и управлением версиями, похожим на Google Docs или SharePoint.
- HAT-системы (help authoring tools) — специализированные инструменты для создания справочной документации.
- CMS и веб-редакторы — понимание особенностей форматирования, влияния CSS и структуры контента.
- HTML и гипертекст — базовые знания для создания ссылок, семантической разметки и корректного представления контента.
- Git и версионирование — графический интерфейс GitHub помогает отслеживать изменения и работать совместно с разработчиками (опционально, зависит от команды).
- Docs-as-Code — базовое понимание подхода к документации как к коду и умение работать с инструментами генерации статических сайтов.
- ИИ-инструменты — использование помощников вроде GitHub Copilot или встроенных функций редакторов для ускорения создания текстов и улучшения качества документации.
Эти навыки позволяют техпису быстро адаптироваться к современным требованиям и интегрироваться в процессы разработки и публикации документации.
* * *
В мире технологий роль технического писателя выходит далеко за рамки грамотного письма. Чтобы оставаться востребованным, важно осваивать новые инструменты и подходы, понимать процессы разработки и уметь работать в команде. Инвестиции в Docs-as-Code, знание API, интеграция с DevOps и внимание к UX делают технического писателя полноценным участником IT-процессов и позволяют создавать документацию, которая действительно помогает пользователям.
