Профессия Технический писатель

Технический писатель - это специалист, который создаёт документацию для IT-продуктов: руководства пользователя, API-документацию, технические спецификации, инструкции по установке, релиз-ноуты и базы знаний. Он переводит сложный технический язык на понятный для пользователей и разработчиков. Технический писатель - это переводчик между разработчиками, пользователями и бизнесом.

Инструменты

• Редакторы: Markdown, reStructuredText, AsciiDoc
• Инструменты для документации: Read the Docs, Docusaurus, GitBook, Confluence, Notion
• API-документация: Swagger, Postman, OpenAPI
• Диаграммы и схемы: Draw.io, Miro, Lucidchart
• Скринкасты и скриншоты: Snagit, OBS, Greenshot
• Git (для версионирования документации)

Роадмэп

Чтобы стать техническим писателем, нужно пройти такой путь:

1. Изучить основы технического письма и структурирования информации.
2. Освоить Markdown и работу с Git.
3. Изучить инструменты для создания документации (Confluence, GitBook).
4. Освоить создание API-документации (Swagger, OpenAPI).
5. Изучить работу с диаграммами и визуализацией.
6. Освоить работу с продуктом и общение с разработчиками.
7. Собрать портфолио: 3-5 примеров документации.
8. Начать искать работу.

Типичный день

Утро технического писателя начинается с созвона с разработчиками, чтобы обсудить новую функциональность, которую нужно задокументировать. Он изучает API, пишет черновик документации в Markdown, проверяет примеры кода, создаёт схемы в Draw.io. После обеда отправляет документацию на ревью разработчикам, правит по замечаниям, обновляет базу знаний. К вечеру пушит документацию в Git и обновляет задачи в Jira.

Сложности

• Разработчики часто не любят писать документацию.
• Сложно объяснить сложные технические вещи простым языком.
• Документация быстро устаревает, нужно постоянно обновлять.
• Трудно получить доступ к экспертам и разработчикам.
• Работа требует высокой точности и внимательности.

Вход

Минимальный порог входа - знание основ IT, технического письма, Markdown, Git и инструментов для документации.

Рост

Из технического писателя можно расти в такие профессии:

• Ведущий технический писатель - управление проектами и командой.
• Специалист по контенту (Content Strategist) - стратегия документации.
• Продукт-менеджер - переход в управление продуктом.
• Developer Advocate - переход к работе с сообществом.
• Менеджер по документации - управление всей системой документации.