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

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

Обзор документации¶

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

Системная документация¶

Паспорт системы¶

Файл: SYSTEM_OVERVIEW.md

Содержит общие сведения о системе:

Наименование и тип системы
Назначение системы
Область применения
Типы учреждений
Категории пользователей
Функциональные возможности
Состав программных средств
Требования к техническим средствам
Требования к информационной безопасности
Масштабируемость и надежность
Эксплуатация и сопровождение

Архитектура системы¶

Файл: architecture.md

Подробное описание архитектуры системы:

Общая схема архитектуры
Структура проекта
Frontend архитектура
Backend архитектура
Слои архитектуры
Паттерны проектирования
База данных
Асинхронная обработка (Outbox Pattern)
Безопасность
Интеграции
Масштабируемость
Поток данных

Пользовательская документация¶

Руководство пользователя¶

Файл: USER_GUIDE.md

Руководство для конечных пользователей системы:

Вход в систему
Роли пользователей
Работа с книгами
Операции с книгами (выдача, возврат, продление)
Бронирования
QR-коды
Инвентаризация
Управление пользователями
Справочники
Настройки
Советы и рекомендации
Часто задаваемые вопросы

Техническая документация¶

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

Файл: API.md

Документация по REST API:

Обзор API
Базовый URL
Аутентификация
Формат ответов
Коды статусов HTTP
Эндпоинты:
Аутентификация
Книги
Экземпляры книг
Операции
Бронирования
Пользователи
Справочники
QR-коды
Статистика
Обработка ошибок
Rate Limiting
CSRF Protection
Версионирование API

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

Интерактивная документация API доступна по адресу:

Development: http://localhost:3000/api-docs
Production: https://ais.irk138.ru/api-docs

Swagger документация позволяет:

Просматривать все доступные эндпоинты
Изучать структуру запросов и ответов
Тестировать API прямо в браузере
Экспортировать спецификацию OpenAPI

Документация по развертыванию¶

Руководство по развертыванию¶

Файл: DEPLOYMENT.md

Подробное руководство по развертыванию системы:

Требования к инфраструктуре
Локальное развертывание
Развертывание с Docker
Production развертывание
Настройка Nginx
Настройка SSL
Резервное копирование
Мониторинг и логирование
Обновление приложения
Откат изменений
Безопасность
Troubleshooting

Документация для разработчиков¶

Руководство разработчика¶

Файл: DEVELOPER_GUIDE.md

Руководство для разработчиков, работающих с исходным кодом:

Начало работы
Структура проекта
Архитектура
Стандарты кодирования
Работа с Git
Тестирование
Отладка
Добавление новых функций
Полезные команды
Полезные ресурсы

Коммерческая документация¶

Коммерческое использование и лицензирование¶

Файл: COMMERCIAL.md

Информация о коммерческом использовании:

Правовой статус программного обеспечения
Open Source лицензия (Apache License 2.0)
Коммерческое лицензирование
Сопровождение и поддержка
Ограничение ответственности
Порядок получения коммерческой лицензии
Стоимость и условия оплаты
Гарантийные обязательства
Конфиденциальность

Доступ к документации¶

Онлайн доступ¶

Вся документация доступна в репозитории проекта в папке docs/.

Локальный доступ¶

Для работы с документацией локально:

Клонируйте репозиторий проекта
Откройте файлы документации в любом редакторе, поддерживающем Markdown
Используйте Markdown-просмотрщик для удобного чтения

Генерация документации¶

Для генерации HTML-версии документации можно использовать инструменты:

MkDocs — генератор статической документации
GitBook — платформа для создания документации
Docusaurus — генератор статических сайтов для документации

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

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

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

При обнаружении неточностей или ошибок в документации, а также при необходимости дополнительной информации обращайтесь по контактным данным, указанным на странице Контакты.

Главная | О системе | Архитектура | Контакты