Назад
Требования к системе
Архивация системы (Дистрибутив)
- Архив
ИмяПроекта_v1.0.zip(или .rar/.7z для лучшего сжатия). Рекомендуется .zip как наиболее универсальный для всех ОС. - Вместе с системой архивируются: дамп БД, файл «Доступ.txt», инструкция по развертыванию.
- Размер архива оптимизирован: удалены временные файлы, кэш (
__pycache__,.cache,node_modules,*.log,.idea,.vscode). - Создайте скрипт очистки
clean.batилиclean.shдля удаления лишних файлов перед архивацией. - Папка
_Externalили_Dependencies: файлlinks.txt— ссылки на PostgreSQL, Python, Node.js и т.д.; подпапкаoffline_installers/для легковесных установщиков (VC++ Redistributable, драйверы СУБД).
Данные доступа (файл Доступ.txt)
- Файл «Доступ.txt» в корне архива — структурированный документ с разделами.
- 1. Адреса системы: главная страница, админ-панель, API (если есть).
- 2. Учётные записи для тестирования: для каждой роли (Администратор, Менеджер, Пользователь) — логин и пароль.
- 3. Доступ к БД: хост, порт (3306/5432), имя БД, пользователь, пароль.
- 4. Важные примечания: особенности паролей по умолчанию (.env), способ получения Bearer-токена для API.
База данных
- Дамп БД в составе архива. Рекомендуется отдельный архив с БД для удобства.
- Формат: SQL или иной, соответствующий СУБД. Указать версию СУБД (дамп MySQL 8.0 может не загрузиться в 5.7).
- Два скрипта:
schema.sql— структура (CREATE TABLE);data.sql— тестовые данные (INSERT). - В корне архива — ссылка или путь к дампу: папка
database_dumpили файлDB_DOWNLOAD_LINK.txt.
Инструкция по развертыванию (README.md)
- Формат README.md (Markdown) — отображается на GitHub и в редакторах кода.
- Структура: введение, системные требования (PHP, Node.js, расширения, RAM), prerequisites (Git, веб-сервер, СУБД, Composer/NPM).
- Пошаговая установка: распаковка, настройка веб-сервера (.htaccess/vhost Nginx), копирование .env.example → .env,
composer install,npm install, импорт БД (mysql -u root -p mydb < database/schema.sql), миграции (php artisan migrate), сиды (php artisan db:seed), права (chmod -R 775 storage). - Troubleshooting: 403 Forbidden → права на папки; «Не подключается к БД» → .env и статус сервера БД; пустая страница →
display_errors = On.
Среда исполнения (Runtime)
- Предоставить ссылки для скачивания требуемых компонентов (PHP, Node.js, СУБД, фреймворков и т.п.).
- Включить инструкции по установке дополнительных библиотек или модулей (
composer install,npm install,pip install). - Указать версии ПО, с которыми система была протестирована.
- Включить установщики требуемого ПО в архив — в папку
_Externalилиoffline_installers/(VC++ Redistributable, драйверы СУБД и др.). - Docker (рекомендация): файл
docker-compose.ymlв корне — поднимет веб-сервер, СУБД и кэш. Проверяющему достаточно установить Docker и выполнитьdocker-compose up.
Интерактивная инструкция
- Реализовать пошаговые инструкции с визуальными подсказками (подсветка элементов интерфейса, нумерация шагов).
- Включить демонстрационные сценарии использования системы — типовые задачи с пошаговым описанием.
- Предусмотреть режим обучения с подсказками для новых пользователей (онбординг при первом входе).
- Папка
docs/:USER_GUIDE.pdfили HTML-страницы с навигацией. - Онбординг: библиотека intro.js — подсветка кнопок при первом входе.
- Видео-гиды: ссылки на YouTube или .gif в
docs/screencasts/— скринкасты ключевых сценариев. - Демо-сценарии: текст «Сценарий 1: Создание заказа» + скриншоты или GIF.