Документация проекта

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

Как это работает

Автоматическая публикация:

• Документация хранится в репозитории проекта
• CI/CD процесс отправляет файлы на сайт при каждом изменении
• Документация всегда актуальна — обновляется вместе с кодом

Дополнительные страницы:

• В Obsidian можно создать страницы навигации
• Главная страница со ссылками на разделы
• Гайды и туториалы поверх технической документации

Кто получает доступ

Разработчики:

• Пишут документацию рядом с кодом
• Видят результат на сайте

Пользователи продукта:

• Читают инструкции и API-документацию
• Не нужен доступ к репозиторию

Менеджеры и другие команды:

• Понимают, как работает продукт
• Находят ответы без вопросов разработчикам

Уведомления о релизах

Новый релиз — новый пост в Telegram канале:

• Changelog публикуется как пост
• Пользователи узнают об обновлениях сразу
• Пост ссылается на документацию на сайте

Что получает команда

• Документация не отстаёт от кода
• Один источник правды — репозиторий
• Удобный доступ для всех — через сайт
• Уведомления о релизах — через Telegram