Наверх
EN

Тексты

Техническая документация: руководства, архитектурные документы, инструкции, описания API

Где писал документацию

Что пишу

Документацию к программным продуктам и оборудованию. Для разработчиков, пользователей и партнеров, на русском и английском.

  • Руководства и инструкции.
  • Архитектурные документы и описания API.
  • Материалы для онбординга сотрудников и клиентов.
  • Стайлгайды документации: терминология, структура, оформление.
  • Комплекты документов для регистрации программ в реестре отечественного ПО (ЕРРП).
  • Тексты для интерфейсов.
  • Перевод технической документации с русского на английский и обратно.

Кейсы

Документация с нуля для платформы Мапиус

Холдинг Т1, Иннотех · 2024–2026 · технический писатель

Задача
Создать с нуля техническую документацию для Мапиус, платформы для управления API от Т1 Иннотех. Платформа разворачивается on-premise, то есть в инфраструктуре заказчика. Анонс платформы на сайте Т1.
Что сделал
  • Написал документацию на платформу.
  • Подготовил пакет документации для коммерциализации платформы, включая презентации и материалы для онбординга.
  • Разработал комплект документов для регистрации продукта в ЕРРП.
Результат
У платформы есть полная документация, материалы для вывода на рынок и комплект документов для реестра.

Порталы документации, которые команды запускают сами

Холдинг Т1, Иннотех · 2024–2026 · технический писатель

Задача
Дать командам разработки возможность самим вести и публиковать документацию.
Что сделал
  • Внедрил систему управления знаниями в подходе Docs as Code на GitLab CI, Docker и Kubernetes.
  • Выстроил и стандартизировал процессы документирования в Agile-среде и встроил их в рабочие циклы команд разработки.
  • Стал соавтором инструмента для автоматического развертывания проектов Docs as Code.
Результат
Команды сами запускают порталы с документацией, без DevOps-инженеров и технических писателей.

AI-агент для поддержки пользователей

Байкал Электроникс · 2023 · технический писатель

Задача
Отвечать на обращения пользователей на основе внутренней документации компании.
Что сделал
Разработал AI-агента для поддержки. Он анализирует запросы пользователей и формирует ответы по внутренним документам компании.
Результат
Агент обрабатывает 60% обращений без участия сотрудников.

Документация для процессоров Baikal-T, Baikal-M и Baikal-S

Байкал Электроникс · 2022–2024 · технический писатель

Задача
Задокументировать программно-аппаратную часть процессоров и сделать документацию доступной международным партнерам.
Что сделал
  • Разрабатывал документацию по программно-аппаратной части процессоров.
  • Переводил ее с русского на английский для международных партнеров.
  • Внедрил систему управления знаниями в подходе Docs as Code.
  • Регулярно участвовал в peer review документации.
  • Создал набор из 50+ компонентов для оформления схем и диаграмм.
Результат
Запустил портал документации для SDK по принципу Docs as Code: sdkdocs.baikalelectronics.ru. Сайт и его содержание принадлежат Байкал Электроникс. С моего ухода в 2024 году я их не поддерживаю, поэтому сейчас они могут отличаться от того, что делал я.

Docs as Code для документации внешнего заказчика

Холдинг Т1, Иннотех · 2024–2026 · технический писатель

Задача
Обеспечить поддержку документации для внешних заказчиков: собирать новую документацию из документации заказчика и других источников и вести ее по правилам Docs as Code.
Что сделал
  • Описал, как вести версии: у документации заказчика и у нашей свои ветки, у каждого заказчика своя.
  • Разобрал, как переносить изменения из версий заказчика в нашу документацию, и предложил для этого промежуточный слой (middleware), который превращает документ заказчика в исходники в Markdown.
  • Предусмотрел каналы публикации: PDF, сайт и сайт на стороне заказчика.
  • Рассказал команде коммерции о новом процессе и показал инструмент на демо.
  • Запустил пилот на VS Code, GitLab, Т1 Cloud и Diplodoc.
Результат
Пилот запущен. Из одних исходников документация публикуется в PDF и на сайте.

Как работаю

Документация живет рядом с кодом: так она меняется вместе с продуктом.

  • Пишу в Markdown и AsciiDoc, храню в Git.
  • Коллеги проверяют тексты на peer review.
  • GitLab CI или Jenkins собирают и публикуют портал, Docker и Kubernetes его запускают.
  • Процессы встроены в рабочие циклы Agile-команд.
  • Работаю с инженерами, тимлидами, менеджерами и владельцами продуктов, специалистами по ИБ и продажам.

Было и стало

Условный пример: сообщение об ошибке, оригинал и мой вариант. Режим можно переключать.

Что изменилось:

  • Вместо кода сказано, что именно не получилось.
  • Причина названа обычными словами.
  • Понятно, что делать дальше.

Реальная работа: портал документации SDK Байкал Электроникс. Сайт и его содержание принадлежат компании, я их больше не поддерживаю.

Ошибка 0x80070005: доступ запрещен.Не удалось сохранить файл «Отчет.docx»: у вас нет прав на запись в эту папку. Обратитесь к администратору.Сохраните файл в «Документы» или попросите администратора выдать доступ.

Инструменты

Тексты и перевод
Markdown, AsciiDoc, Confluence, MS Office. UX-тексты, технический перевод.
Сборка и публикация
Git, GitLab CI, Jenkins, Docker, Kubernetes, генераторы статических сайтов (SSG), Linux, VS Code.
API и код
API, Postman, Python, HTML, CSS, JavaScript.
Схемы и дизайн
Figma, Draw.io, UML.
Процессы
Agile, Jira, peer review, технические задания.

Контакты