1. Общие положения

1.1. Настоящая должностная инструкция устанавливает трудовые функции, обязанности, права и ответственность технического писателя (включая наименования: Technical Writer, разработчик технической документации, инженер по документированию ПО).

1.2. Должность технического писателя относится к категории IT-специалистов проектно-производственного блока.

1.3. Назначение на должность и освобождение от нее осуществляется приказом Генерального директора компании по согласованию с Техническим директором (CTO) или Руководителем группы документирования (Lead Tech Writer).

1.4. Технический писатель непосредственно подчиняется Лиду направления технического писательства / Руководителю проектного офиса (PMO) / Product Owner.

1.5. В своей работе специалист руководствуется Трудовым кодексом РФ, государственными стандартами ЕСПД (ГОСТ серии 19) и КСАС (ГОСТ серии 34), правилами корпоративного стайлгайда (Style Guide) и регламентами информационной безопасности.

2. Квалификационные требования к должности

2.1. Образование: Высшее образование (техническое в сфере ИВТ/ПМИ, филологическое или лингвистическое с профильной IT-переподготовкой).

2.2. Опыт работы: От 1 года на позиции Junior/Middle Technical Writer в продуктовой или заказной IT-разработке.

2.3. Технический писатель должен знать:

• Принципы архитектуры ПО, клиент-серверного взаимодействия, форматы сериализации данных (JSON, XML, YAML);
• Инструменты документирования API (Swagger/OpenAPI, Postman, Redoc);
• Подход Docs-as-Code (Git, Markdown, AsciiDoc, генераторы статических сайтов Hugo/Docusaurus/MkDocs);
• Стандарты разработки документации: ГОСТ 19.ххх, ГОСТ 34.ххх, ГОСТ Р 59795-2021, ISO/IEC/IEEE 26514;
• Инструменты для ведения баз знаний: Confluence, Notion, GitBook;
• Основы реляционных баз данных и язык базовых SQL-запросов;
• Английский язык на уровне не ниже Upper-Intermediate (B2) для ведения международной технической документации.

Классификаторы должности

3. Должностные обязанности

Технический писатель выполняет следующие производственные задачи:

3.1. Создание и актуализация документации:

• Разрабатывает руководства пользователя (User Manuals), руководства системного администратора, инструкции по развертыванию и установке ПО.
• Создает технические задания (ТЗ), программы и методики испытаний (ПМИ), пояснительные записки по ГОСТ 34 и 19.
• Описывает REST/gRPC/GraphQL API сервисов, схемы запросов/ответов, коды ошибок и сценарии интеграции.
• Формирует статьи базы знаний, Release Notes (описания релизов), Changelog и FAQ для службы технической поддержки.

3.2. Взаимодействие с командами и аудит:

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

4. Права

Технический писатель имеет право запрашивать доступ к тестовым стендам, исходному коду, трекерам задач (Jira) и спецификациям архитектуры; инициировать уточнение логики работы системы при обнаружении расхождений; блокировать публикацию релиза при отсутствии критически важной документации.

5. Ответственность

Специалист отвечает за наличие фактических и логических ошибок в документации, срыв согласованных дедлайнов сдачи технических паспортов/ТЗ и утечку закрытых сведений о внутренней архитектуре систем (NDA).

6. KPI и взаимодействие

Взаимодействует с разработчиками, аналитиками, PM, релиз-инженерами. KPI: Своевременность покрытия релизного функционала документацией (100%), процент устаревших статей в базе знаний (<2%), индекс понятности документации по оценкам техподдержки.