Что я делаю в роли Technical Writer
- Описываю функциональность ИТ-продукта с точки зрения пользовательских сценариев и технической реализации.
- Создаю и поддерживаю в актуальном состоянии базу знаний проекта.
- Пишу release notes для команды проекта.
- Читаю и создаю техническую документацию: API, инструкции, регламенты.
- Уточняю детали работы функциональности в связке с разработкой, QA, аналитикой и дизайном.
Кейсы
| Кейс | Что внутри |
|---|---|
| Архитектура и диаграммы | C4/sequence, зависимости, контекст |
| Документация API | endpoint’ы, примеры, ошибки |
| Сценарий: создание заказа | сквозной flow UI → API → backend |
| Инцидент: сбой оплаты | диагностика, шаги восстановления |
| Release Notes | формат релизных заметок: для пользователей, поддержки и команды |
| Knowledge Base | структура базы знаний и процесс актуализации |
| Docs as Code pipeline | процесс обновления и review документации |