8. Документирование

8.1. Виды документации

Система сопровождается следующими видами документации:

1. Руководство пользователя:
2. Описание функциональности системы
3. Инструкции по работе с модулями
4. Описание пользовательского интерфейса
5. Примеры использования
6. Руководство администратора:
7. Инструкции по установке и настройке
8. Описание системных настроек
9. Инструкции по управлению пользователями
10. Инструкции по резервному копированию и восстановлению
11. Техническая документация:
12. Описание технической архитектуры
13. Описание API
14. Описание базы данных
15. Инструкции для разработчиков
16. Документация по лицензированию:
17. Описание системы лицензирования
18. Инструкции по активации лицензии
19. Описание процесса обновления

8.2. Процесс документирования

Документация создается и обновляется в процессе разработки:

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

8.3. Форматы документации

Документация предоставляется в следующих форматах:

• Markdown файлы в репозитории
• HTML версии документации
• PDF версии