О портфолио
Данный проект представляет собой портфолио технического писателя. Документация разработана в соответствии с требованиями государственных стандартов Единой системы программной документации (ГОСТ 19) и автоматизированных систем (ГОСТ 34), на базе инструментов Foliant, Pandoc и Docker.
Процессы визуализированы с помощью схем (draw.io), диаграмм (BPMN 2.0) и таблиц — файлы доступны в разделе diagrams.
Автоматизация подготовки документации
Документация подготовлена на языке Markdown и собирается в итоговые форматы (DOCX, PDF) с помощью инструментов Foliant и Pandoc в среде Docker.
Сборка полностью автоматизирована: при каждом изменении в основной
ветке репозитория SourceCraft CI/CD автоматически запускает рабочий
процесс build-gost-docs, который выполняет установку
зависимостей и сборку документов в едином Docker-образе
foliant/foliant:pandoc. Это гарантирует воспроизводимость
результата независимо от окружения.
Технологический стек
| Инструмент | Назначение |
|---|---|
| Markdown | Язык разметки для написания исходников документации (директория src/). |
| Foliant | Сборщик документации: объединяет главы из Markdown-файлов по конфигурации foliant.yml. |
| Pandoc | Конвертер: формирует итоговые документы в форматах DOCX и PDF. |
| Docker | Среда сборки (образ foliant/foliant:pandoc) — единое и повторяемое окружение. |
| draw.io / BPMN 2.0 | Визуализация процессов: схемы архитектуры и диаграммы бизнес-процессов. |
| SourceCraft CI/CD | Автоматический запуск сборки DOCX/PDF при изменениях в ветке main. |
Этапы автоматической сборки
- Изменения в Markdown-исходниках (
src/) сохраняются в веткеmain. - Workflow
build-gost-docsзапускается автоматически (push / pull request). - В Docker-контейнере
foliant/foliant:pandocустанавливаются зависимости и шрифты. - Foliant выполняет сборку проекта по конфигурации
foliant.yml. - Pandoc генерирует итоговые файлы: DOCX и PDF.
- Готовые документы сохраняются как артефакты сборки в разделе CI/CD репозитория.
ГОСТ 19 (ЕСПД)
Документы Единой системы программной документации.
Примеры работ для работодателя
Четыре примера документации, демонстрирующих владение разными видами технической документации: проектной, эксплуатационной, пользовательской и административной. Документы подготовлены с соблюдением корпоративных стандартов и требований ГОСТ 19 / ГОСТ 34, процессы визуализированы схемами (draw.io) и диаграммами (BPMN).
Проектная документация
Технический проект АСУ-УК по ГОСТ 34.601-90 и ГОСТ 34.201-89.
Эксплуатационная документация
Руководство оператора по ГОСТ 19.505-79, регламент обработки инцидентов.
Пользовательская документация
Руководство пользователя модуля отчетности по ГОСТ 19.101-77.
Административная документация
Руководство администратора: корпоративный стандарт СТО-ИТ-003 + ГОСТ 34.601-90.