В узком значении, наша задача – документирование продуктов в компании.

Но писатель сейчас не ограничен только лишь написанием текстов:

• Управление командой: процессы, планирование, постановка задач, контроль
• Рецензирование, нормоконтроль
• Документирование API: тексты для разработчиков, инструменты, программирование
• DocOps: автоматизация, настройка процессов
• UX: тексты в интерфейсе
• Контент-маркетинг: статьи о технологиях, новинках продуктов компании, помощь инженерам
• Управление знаниями: создание и поддержка базы знаний, процессы
• Контент-стратегия: анализ поведения пользователей, посещаемость, метрики, улучшение документации

Каждый работодатель понимает должностные обязанности писателя по-разному.

Часто в вакансиях указаны обязанности аналитика: написание ТЗ, общение с клиентов и т.д.

Также есть проф. стандарт от Минтруда. Им редко пользуются, но можно ознакомиться.

Самое важное:

• грамотность
• любовь к текстам
• умение объяснять и учить
• страсть к получению знаний, новой информации

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

Собеседуем технических писателей, https://youtu.be/7fuz87VkOB4

Все зависит от проекта, но можно выделить активности:

• daily-митинги, совещания, ретроспективы, планировние работ
• сбор информации:
  • изучение своего продукта, новых фич
  • интервью с разработчиками или другими участниками команды
  • анализ проектных артефактов: задачи в таск-менеджере, ТЗ, ТП, отчеты по тестированию, обращения в службу поддержки
• работа с текстом: структура, написание, оформление
• рецензирование текстов в команде
• изучение инструментов документирования

https://documentat.io/courses/

http://documentat.io/to/courses/open-course/

Прошедшие лекции:

1. Два определения технической документации. Какая документация необходима в вашем проекте? Кто такой техписатель и зачем он вам нужен. https://youtu.be/w0DNTDE3EgE
2. Документация — или процесс? Что с документацией не так? Как это поправить? https://youtu.be/BG5yBiyZTRc
3. Жизненные циклы технических документов. https://youtu.be/qF9hDviKBYM
4. Требования к документационному инструментарию. https://youtu.be/Sawz84gY4Uk
5. Введение в DocOps (Николай Волынкин, Plesk) https://youtu.be/1CuMeMYwtbg
6. Как создать инфраструктуру документирования как кода на примере инструмента Foliant (Константин Валеев, руководитель отдела аналитики и документации в Ростелеком ИТ) https://youtu.be/6CKVodl2YcA
7. ГОСТ 19 в современной разработке (Константин Валеев, руководитель отдела аналитики и документации в Ростелеком ИТ) https://youtu.be/1P18VkS7ORQ
8. Для чего нужны Help Authoring Tools на примере MadCap Flare (Ольга Морланг, Petrosoft, руководитель группы технических писателей) https://youtu.be/6fAQ1HC5fqI
9. Локализация документации (Екатерина Носкова, руководитель отдела документирования, Xsolla) https://youtu.be/UYRKX1ZuUzw
10. ГОСТ 34 в современной разработке, часть 1 (Константин Валеев, руководитель отдела аналитики и документации в Ростелеком ИТ), https://youtu.be/Cb7oyeIjWZ8
11. ГОСТ 34 в современной разработке, часть 2 (Константин Валеев, руководитель отдела аналитики и документации в Ростелеком ИТ), https://youtu.be/NLXbsE_HOJY
12. ГОСТ 34 в современной разработке, часть 3 (Константин Валеев, руководитель отдела аналитики и документации в Ростелеком ИТ), https://youtu.be/O9896hB0DSM

Слайды всех лекций: https://speakerdeck.com/documentatio

Чат курса: https://t.me/TechDocIT

https://developers.google.com/tech-writing

• https://starkovden.github.io/
• https://archways.ru/courses/rest

• Хабр Карьера
• zarplan.com
• Зарплата UX-писателей в 2023 году

• linkedin.com через VPN
• Телеграм-чаты по тегам #wanted_tw и #tw_wanted
• https://career.habr.com/
• https://freelance.habr.com/
• hh.ru

• Знания ГОСТ 19, ГОСТ 34. Не нужно их знать наизусь, важно понимать, где найти нужную информацию по оформлению, структуре и содержанию документов
• Word и другие офисные приложения
• Опционально знания нотаций, например, BPMN

Все зависит от конкретного места работы, проекта. Примеры навыков:

• docs-as-code:
  • Языки легковесной разметки: markdown, restructuredtext, asciidoc
  • Git
  • Опционально CI/CD
• Английский язык
• API
• Инфостиль Максима Ильяхова
• Confluence/Jira/HAT изучаются уже после найма

• Вертикальный: руководство командой/группой/отделом
• Горизонтальный: получение навыков из раздела "Профессия"

https://t.me/technicalwriters

https://t.me/twriters

https://t.me/docsascode

https://t.me/joinchat/Zxo5ioJlnf80OTVi

https://t.me/technical_writing

• Резюме:
  • Актуальный опыт, чтобы фильтры на hh не отсеивали резюме
  • Курсы
• Сопроводительное письмо. Задача – выделиться среди других сооискателей
• Портфолио:
  • тексты из курсов
  • удачные тестовые задания
  • инструкция к какой-либо функции известного софта, мессенджера например
  • текст/инструкция о том, как вы разобрались с интересной технологией в документировании
  • практика на гитхабе, гитлабе. В поиске по issue искать по тегам need help, documentation
  • статьи на https://doka.guide/

• Свои вопросы:
  • https://github.com/sharovatov/teamlead/blob/master/articles/lifecycle.md
  • https://github.com/sharovatov/teamlead/blob/master/articles/company_interview.md
• Сбор информации:
  • Изучить сайт компании: продукты, клиенты, условия работы
  • Изучить документацию на продукты компании
  • Узнать, с помощью каких инструментов разрабатывается документация.

• https://www.youtube.com/watch?v=jiJxA37hmsQ
• https://twitter.com/AlexSukhorukov_/status/1608854342676934661