Общий обзор
Эта страница содержит общую информацию о принципах работы с документацией в SoftonIT.
Структура документации
Документация организована по продуктам и проектам:
- Каждый репозиторий имеет собственное пространство документации
- Документы в формате Markdown находятся в папке
docs/каждого репозитория - Автоматическая сборка происходит при изменениях в основной ветке
Принципы написания
При создании документации следуйте этим принципам:
- Ясность - пишите понятно и структурированно
- Актуальность - поддерживайте документацию в актуальном состоянии
- Полнота - покрывайте все основные аспекты продукта
- Примеры - используйте практические примеры
Форматирование
Используйте стандартный Markdown с поддержкой:
- Блоков кода с подсветкой синтаксиса
- Таблиц
- Диаграмм Mermaid
- Математических формул
- Admonitions (предупреждения, заметки и т.д.)