Документация проекта
Вёл проектную техническую документацию как отдельный инженерный слой вокруг приложения:
- по архитектуре и внутренним правилам;
- по инфраструктуре и окружению;
- по deployment flow;
- по API и интеграциям;
- по developer workflow и командным соглашениям.
VitePress
Использовал VitePress для проектной документации.
Особенности VitePress:
- Markdown-first подход;
- простая структура разделов и страниц;
- быстрая сборка статического сайта документации;
- удобная навигация и sidebar;
- нормальный developer experience для сопровождения docs прямо в репозитории.
Проектную документацию собирал через VitePress и публиковал как отдельный статический раздел. Дополнительно поддерживал отдельный доменный docs-раздел, тоже собранный из Markdown рядом с кодовой базой.
Что обычно документировал
В проектной документации обычно описывал:
- стек проекта;
- локальное окружение;
- deploy и production flow;
- правила разработки;
- внутренние соглашения по API;
- отдельные разделы по доменной логике;
- логирование, кэширование, тестирование и другие инженерные процессы;
- эксплуатационные инструкции и служебные runbook-сценарии.