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

Техническая документация АИС синхронизируется из папки docs/ репозитория проекта и публикуется на этом сайте в разделе Документация (меню слева).

Открыть демо

Быстрый доступ¶

Для библиотекарей и администрации¶

Документ	Описание
Руководство пользователя	Вход, роли, книги, выдача, бронирования, QR, инвентаризация
Паспорт АИС	Общее описание системы для заказчика и ИБ
Пилотное внедрение	План пилотного внедрения

Для IT-отдела¶

Документ	Описание
Развёртывание	Установка, бэкапы, production
Docker	Compose, профили, команды
Быстрый деплой Ubuntu	Сервер, домен, SSL
Деплой с доменом	Nginx, сертификаты, переменные окружения
Мониторинг	Prometheus, Grafana, алерты
Архитектура (техн.)	Слои, паттерны, БД, outbox

Для разработчиков¶

Документ	Описание
API	REST API, коды ответов, эндпоинты
Руководство разработчика	Git, тесты, стандарты кода
Коммерческое использование	Лицензия, сопровождение, договоры
План улучшений	Дорожная карта доработок

Интерактивная API-документация (Swagger)¶

В режиме разработки и на развёрнутом backend:

Development: http://localhost:3000/api-docs
Production (демо): https://library.codnix.ru/api-docs

Swagger позволяет просматривать эндпоинты, схемы запросов/ответов и тестировать API в браузере.

Обновление документации на сайте¶

Документация на ais.irk138.ru собирается из двух источников:

Маркетинговые страницы — marketing-site/docs/ (главная, пилот, лицензирование и т.д.).
Техническая документация — копия docs/ проекта в marketing-site/docs/technical/.

Перед публикацией выполните:

python scripts/sync-marketing-docs.py
cd marketing-site
pip install -r requirements.txt
mkdocs build

Содержимое папки marketing-site/site/ загрузите на хостинг ais.irk138.ru.

Обратная связь¶

Неточности в документации или запрос дополнительных материалов — admin@irk138.ru (тема: «Вопрос по документации»).

См. также: Контакты.