Обо мне
Меня зовут Александр, я технический писатель.
Разрабатываю документацию на программное обеспечение более 10 лет. Помогаю софтверным компаниям создавать удобную и понятную документацию для пользователей, администраторов и разработчиков.
Я не только работаю с текстом, но и:
- внедряю технологии и выстраиваю процессы документирования,
- обучаю сотрудников и управляю командой,
- автоматизирую разработку документации,
- помогаю писать инженерам о технологиях и продуктах компании,
- развиваю базу знаний.
Мне интересны проекты, в которых используется или внедряется принцип docs as code. Не рассматриваю проекты с разработкой документации по ГОСТ.
Достижения
- С нуля разработал документацию на инструмент нагрузочного тестирования Boomq: от выбора инструментов до релиза.
- Руководил проектом по переходу с CHM на веб-формат документации в DIRECTUM.
- Успешно управлял командой из 3 технических писателей.
- Был наставником у 4 сотрудников. Все успешно прошли испытательный срок.
Опыт работы
- Май 2019 – настоящее время · Performance Lab
- Разработка документации для инструмента нагрузочного тестирования Boomq и ее перевод на английский язык
- Редактирование документации на проекте «Тестирование стабильности Транспортного сервера» в АО «ИнфоТеКС»
- Разработка документации на проекте «Внедрение продукта «Автоматизированное и нагрузочное тестирование» в ПАО «Газпром нефть»
- Документирование компонентов среды разработки Национальной системы управления данными и процесса CI/CD в НИИ «Восход»
- Ведение базы знаний и разработка документации на проекте «Нагрузочное тестирование систем ВТБ»
- Разработка документации и ПМИ на функциональные блоки АПК «Безопасный город», адаптеры «КАМИ» и «Кобра»
- Редактирование статей инженеров о технологиях и продуктах компании
- Технологическая поддержка документирования
- Обучение сотрудников
- Разработка документации для инструмента нагрузочного тестирования Boomq и ее перевод на английский язык
- Январь 2018 – май 2019 · Техносерв Менеджмент
- Разработка документации, ТЗ, ПМИ на программные комплексы ЕГИССО и «Клиентская служба ПФР»
- Управление командой
- Работа с новыми сотрудниками и кандидатами: наставничество, проверка тестовых заданий, участие в собседованиях
- Администрирование Confluence
- Технологическая поддержка документирования
- Разработка документации, ТЗ, ПМИ на программные комплексы ЕГИССО и «Клиентская служба ПФР»
- Июль 2017 – декабрь 2017 · Онлайн-Решения
- Разработка документации, ТЗ, ПМИ на программный комплекс «Клиентская служба ПФР»
- Администрирование Confluence
- Технологическая поддержка документирования
- Разработка документации, ТЗ, ПМИ на программный комплекс «Клиентская служба ПФР»
- Октябрь 2011 – июль 2017 · Directum
- Разработка документации для систем: DIRECTUM, Prestima, КАС «Бизнес Люкс», Synerdocs
- Управление командой
- Разработка функциональности веб-справки
- Создание обучающих видеороликов
- Работа с новыми сотрудниками и кандидатами: наставничество, проверка тестовых заданий, участие в собседованиях
- Анализ UX и UI
- Технологическая поддержка документирования
- Разработка документации для систем: DIRECTUM, Prestima, КАС «Бизнес Люкс», Synerdocs
- Сентябрь 2010 – сентябрь 2011 · Институт развития образования
- Администрирование пользовательских ПК и оргтехники
- Поддержка работоспособности серверов
- Администрирование сайта Института
- Техническая поддержка занятий, конференций, семинаров, вебинаров
- Администрирование пользовательских ПК и оргтехники
Примеры работ
Документация
- Boomq. Руководство пользователя
- Руководство пользователя платформы для тестирования нагрузки и производительности.
- HelpDesk. Работа с заявками
- Тестовое задание: руководство по работе с заявками для условной системы HelpDesk.
- Центр администрирования служб DIRECTUM 5.4
- Раздел в руководстве администратора о сайте для настройки, запуска служб и мониторинга системы. Для доступа необходима регистрация на https://club.directum.ru.
- Архитектура системы DIRECTUM 5.4
- Описание архитектуры системы с функциональными схемами. Для доступа необходима регистрация на https://club.directum.ru.
- Серверные события в DIRECTUM 5.4
- Раздел в руководстве разработчика об использовании, создании и запуске серверных событий. Для доступа необходима регистрация на https://club.directum.ru.
Учебные проекты
- Docs as Code
Цель: познакомиться с принципом Docs as Code, изучить технологии и инструменты:
- Foliant – инструмент создания документации,
- Markdown – язык разметки,
- Git – система контроля версий,
- GitHub Pages – хостинг,
- Travis CI – веб-сервис для сборки и тестирования ПО,
- VS Code – текстовый редактор.
Дополнительно рассмотрел работу с Docker, Swagger и GostDOWN.
- Foliant – инструмент создания документации,
- Sphinx и reStructuredText
Цель: познакомиться с Sphinx и reStructuredText.
Задачи:
- Создать проект Sphinx для документации на языке разметки reStructuredText.
- Генерировать документацию в формате HTML.
- Генерировать документацию в формате PDF.
- Хранить исходники в Git.
- Публиковать сайт с документацией на ReadTheDocs
- Создать проект Sphinx для документации на языке разметки reStructuredText.
Разработка
- Функциональность веб-справки DIRECTUM 5.4
Шаблон Help&Manual для сборки документации в HTML.
Функции:
- копирование ссылки на страницу;
- отправка письма в службу поддеержки;
- переход между страницами с помощью кнопок;
- полнотекстовый поиск через Zoom Search Engine.
Для доступа необходима регистрация на https://club.directum.ru.
- копирование ссылки на страницу;
- Видеоплеер для веб-справки DIRECTUM 5.4
Видеоплеер с плейлистом, таймкодом и кнопкой копирования ссылки.
Для доступа необходима регистрация на https://club.directum.ru.
Публикации
Повышаем масштабируемость с DIRECTUM 5.4
10 апреля 2017
· Directum Club
Развиваем подписание и шифрование в DIRECTUM 5.4
3 апреля 2017
· Directum Club
Управляем выполнением кода на серверах
27 марта 2017
· Directum Club
Управляем входящими и исходящими в DIRECTUM 5.3
5 сентября 2016
· Directum Club
Веб-доступ, видео, мобильные решения и другие новинки документации
27 января 2016
· Directum Club
Сдаем объекты в архив системы
14 января 2016
· Directum Club
Создать диалог легко и просто
16 декабря 2015
· Directum Club
Как добавить свои видеоролики в справку
7 августа 2015
· Directum Club
Оптимизация и повышение стабильности DIRECTUM 5.1
13 февраля 2015
· Directum Club
Новинки DIRECTUM 5.1 для разработчиков
30 января 2015
· Directum Club
Обновленный ISBL-редактор в DIRECTUM 5.1
28 января 2015
· Directum Club
Справка на новом уровне
26 января 2015
· Directum Club
Оптимизация репликации в DIRECTUM 5.0
11 марта 2014
· Directum Club
Агент веб-доступа DIRECTUM 5.0
18 февраля 2014
· Directum Club
Электронная подпись с помощью Microsoft Outlook 2010
4 июня 2013
· ECM-Journal
Вклад в сообщество
Участвую в обсуждениях и регулярно делюсь свои опытом в телеграм-чатах:
- Технические писатели
- DocOps-сообщество
- TechWriters.ru
Образование
- 2005 – 2010 · Ижевский государственный технический университет им. М.Т. Калашникова
- Специалист по защите информации
- 090105 · Комплексное обеспечение информационной безопасности автоматизированных систем
