diff --git a/ADMIN_GUIDE.txt b/ADMIN_GUIDE.txt index dce0dfa..6cc06af 100644 --- a/ADMIN_GUIDE.txt +++ b/ADMIN_GUIDE.txt @@ -25,14 +25,15 @@ • Или отправьте команду /start ШАГ 2: Проверка прав администратора - • Если вы администратор, то при нажатии на кнопку доступных вам команд (Слева внизу) вы увидите команду /admin - • Если вы НЕ видите команду /admin - обратитесь к создателю бота + • Если вы администратор, вы увидите главное меню с кнопками управления + • Если вы НЕ видите кнопки управления - обратитесь к создателю бота + • Только создатель бота имеет права назначать администраторов ═══════════════════════════════════════════════════════════════════════════════ 2. ГЛАВНОЕ МЕНЮ АДМИНКИ ═══════════════════════════════════════════════════════════════════════════════ -После ввода команды /admin вы увидите главное меню с кнопками: +После запуска бота вы увидите главное меню с кнопками: 📝 Тесты - управление всеми тестами (создание, редактирование, удаление) 👥 Группы - управление группами студентов @@ -57,6 +58,8 @@ ШАГ 3: Нажмите на любой тест, чтобы увидеть подробную информацию +════════════════════════════════════════════════════════════════════════════ + 3.2. ПРОСМОТР ИНФОРМАЦИИ О ТЕСТЕ После выбора теста вы увидите: @@ -75,35 +78,35 @@ Доступные действия с тестом: 🟢 Активировать / 🔴 Деактивировать - - Включает или выключает доступ студентов к тесту - - Нажмите эту кнопку, чтобы изменить статус + Включает или выключает доступ студентов к тесту + Нажмите эту кнопку, чтобы изменить статус 👁 Показать результаты / 🔒 Скрыть результаты - - Определяет, видят ли студенты свои результаты после прохождения - - Нажмите, чтобы переключить видимость + Определяет, видят ли студенты свои результаты после прохождения + Нажмите, чтобы переключить видимость 📊 Статистика - - Показывает список всех, кто прошёл тест - - Отображает баллы и дату прохождения - - Нажмите на любую попытку, чтобы увидеть детальные ответы + Показывает список всех, кто прошёл тест + Отображает баллы и дату прохождения + Нажмите на любую попытку, чтобы увидеть детальные ответы 🔗 Поделиться - - Создаёт ссылку и QR-код для теста - - Отправьте ссылку студентам для прохождения теста - - QR-код можно распечатать или показать на экране + Создаёт ссылку и QR-код для теста + Отправьте ссылку студентам для прохождения теста + QR-код можно распечатать или показать на экране 📥 Экспорт - - Выгружает результаты теста в Excel файл - - Выберите группу для экспорта - - Получите файл со всеми результатами + Выгружает результаты теста в Excel файл + Выберите группу для экспорта + Получите файл со всеми результатами ✏️ Изменить - - Открывает меню редактирования теста - - Можно изменить пароль, попытки, время, группу, срок - - Можно удалить тест + Открывает меню редактирования теста + Можно изменить пароль, попытки, время, группу, срок + Можно удалить тест ◀️ Назад - - Возвращает к списку тестов + Возвращает к списку тестов ═══════════════════════════════════════════════════════════════════════════════ 4. СОЗДАНИЕ ТЕСТА (ПОДРОБНАЯ ИНСТРУКЦИЯ) @@ -117,7 +120,7 @@ ⚠️ ВАЖНО: Если вы передумали создавать тест, нажмите "◀️ Отмена" на любом этапе ---- +════════════════════════════════════════════════════════════════════════════ 4.2. ЭТАП 1: НАЗВАНИЕ ТЕСТА @@ -140,7 +143,7 @@ ❌ "тест" (слишком общее) ❌ "" (пустое название) ---- +════════════════════════════════════════════════════════════════════════════ 4.3. ЭТАП 2: ОПИСАНИЕ ТЕСТА @@ -159,7 +162,7 @@ ✅ "Проверка знаний по теме 'Великая Отечественная война'" ✅ "Входное тестирование для определения уровня знаний" ---- +════════════════════════════════════════════════════════════════════════════ 4.4. ЭТАП 3: ПАРОЛЬ (НЕОБЯЗАТЕЛЬНО) @@ -184,7 +187,7 @@ ✅ Для закрытых тестов (только для определённых студентов) ❌ Для обычных тренировочных тестов ---- +════════════════════════════════════════════════════════════════════════════ 4.5. ЭТАП 4: КОЛИЧЕСТВО ПОПЫТОК (НЕОБЯЗАТЕЛЬНО) @@ -208,7 +211,7 @@ • Для тренировочных: без ограничений или 3-5 попыток • Для экзаменов: 1-2 попытки ---- +════════════════════════════════════════════════════════════════════════════ 4.6. ЭТАП 5: ЛИМИТ ВРЕМЕНИ (НЕОБЯЗАТЕЛЬНО) @@ -234,7 +237,7 @@ ⚠️ ВАЖНО: Время начинает отсчитываться с момента начала теста! ---- +════════════════════════════════════════════════════════════════════════════ 4.7. ЭТАП 6: СРОК ДЕЙСТВИЯ (НЕОБЯЗАТЕЛЬНО) @@ -259,7 +262,7 @@ ✅ Для домашних заданий с дедлайном ❌ Для тренировочных материалов ---- +════════════════════════════════════════════════════════════════════════════ 4.8. ЭТАП 7: ВЫБОР ГРУППЫ (НЕОБЯЗАТЕЛЬНО) @@ -281,7 +284,7 @@ ⚠️ ВАЖНО: Если у вас нет групп, сначала создайте их в разделе "👥 Группы" ---- +════════════════════════════════════════════════════════════════════════════ 4.9. ЭТАП 8: ПОДТВЕРЖДЕНИЕ ИНФОРМАЦИИ @@ -302,7 +305,7 @@ ⚠️ ВАЖНО: После создания можно будет изменить все параметры, кроме названия и описания! ---- +════════════════════════════════════════════════════════════════════════════ 4.10. ЭТАП 9: ДОБАВЛЕНИЕ ВОПРОСОВ @@ -319,7 +322,7 @@ Нажмите "➕ Добавить вопрос" чтобы продолжить. ---- +════════════════════════════════════════════════════════════════════════════ 4.11. СОЗДАНИЕ ВОПРОСА - ШАГ 1: ТЕКСТ ВОПРОСА @@ -345,7 +348,7 @@ Если передумали добавлять вопрос - нажмите "◀️ Назад" ---- +════════════════════════════════════════════════════════════════════════════ 4.12. СОЗДАНИЕ ВОПРОСА - ШАГ 2: ТИП ВОПРОСА @@ -356,23 +359,23 @@ Три варианта: 📌 Один правильный ответ - - Студент выбирает ОДИН вариант из списка - - Используйте для вопросов с одним правильным ответом + Студент выбирает ОДИН вариант из списка + Используйте для вопросов с одним правильным ответом Пример: "Столица России? а) Москва б) Киев в) Минск" 📋 Несколько правильных ответов - - Студент может выбрать НЕСКОЛЬКО вариантов - - Используйте когда правильных ответов больше одного + Студент может выбрать НЕСКОЛЬКО вариантов + Используйте когда правильных ответов больше одного Пример: "Выберите чётные числа: а) 2 б) 3 в) 4 г) 5" ✏️ Ввод текста - - Студент сам пишет ответ - - Используйте для открытых вопросов + Студент сам пишет ответ + Используйте для открытых вопросов Пример: "Напишите столицу Франции" Нажмите на нужный тип вопроса. ---- +════════════════════════════════════════════════════════════════════════════ 4.13. ТИП ВОПРОСА: ВВОД ТЕКСТА @@ -399,7 +402,7 @@ После ввода переходите к шагу 4.16 (Предпросмотр вопроса) ---- +════════════════════════════════════════════════════════════════════════════ 4.14. ТИП ВОПРОСА: ОДИН ИЛИ НЕСКОЛЬКО ПРАВИЛЬНЫХ - ДОБАВЛЕНИЕ ВАРИАНТОВ @@ -428,7 +431,7 @@ ⚠️ ВАЖНО: Нужно добавить минимум 2 варианта! ---- +════════════════════════════════════════════════════════════════════════════ 4.15. ОТМЕТКА ПРАВИЛЬНЫХ ОТВЕТОВ @@ -472,7 +475,7 @@ ⚠️ ВАЖНО: Должен быть выбран хотя бы ОДИН правильный ответ! ---- +════════════════════════════════════════════════════════════════════════════ 4.16. ПРЕДПРОСМОТР ВОПРОСА @@ -497,7 +500,7 @@ • Вы вернётесь к экрану "➕ Добавление вопросов" • Счётчик вопросов увеличится: "📊 Вопросов добавлено: 1" ---- +════════════════════════════════════════════════════════════════════════════ 4.17. ЗАВЕРШЕНИЕ СОЗДАНИЯ ТЕСТА @@ -530,7 +533,7 @@ ✅ Фильтровать пользователей по группам ✅ Экспортировать результаты по группам ---- +════════════════════════════════════════════════════════════════════════════ 5.2. ПРОСМОТР СПИСКА ГРУПП @@ -551,7 +554,7 @@ 🗑 Удалить группу - удалить существующую группу ◀️ Назад - вернуться в главное меню ---- +════════════════════════════════════════════════════════════════════════════ 5.3. ДОБАВЛЕНИЕ НОВОЙ ГРУППЫ @@ -579,7 +582,7 @@ ❌ 12345 - неправильно (5 цифр) ❌ abc1 - неправильно (буквы) ---- +════════════════════════════════════════════════════════════════════════════ 5.4. УДАЛЕНИЕ ГРУППЫ @@ -621,7 +624,7 @@ ✏️ Ввести ID/Username - найти конкретного пользователя ◀️ Назад - вернуться в главное меню ---- +════════════════════════════════════════════════════════════════════════════ 6.2. ФИЛЬТР ПОЛЬЗОВАТЕЛЕЙ ПО ГРУППЕ @@ -634,7 +637,7 @@ 2. Нажмите "🗑 Сбросить фильтр" 3. Вы снова увидите всех пользователей ---- +════════════════════════════════════════════════════════════════════════════ 6.3. ПОИСК ПОЛЬЗОВАТЕЛЯ @@ -650,7 +653,7 @@ ✅ Если пользователь найден - откроется его профиль ❌ Если не найден - бот сообщит об ошибке ---- +════════════════════════════════════════════════════════════════════════════ 6.4. ПРОСМОТР ПРОФИЛЯ ПОЛЬЗОВАТЕЛЯ @@ -667,22 +670,14 @@ Доступные действия: 📊 Статистика - - Показывает все пройденные тесты - - Отображает баллы и даты - - Можно посмотреть детальные ответы - -👑 Сделать администратором (только для создателя) - - Даёт пользователю права администратора - - Появляется только если пользователь НЕ админ - -🚫 Снять администратора (только для создателя) - - Забирает права администратора - - Появляется только если пользователь админ + Показывает все пройденные тесты + Отображает баллы и даты + Можно посмотреть детальные ответы ◀️ Назад - - Вернуться к списку пользователей + Вернуться к списку пользователей ---- +════════════════════════════════════════════════════════════════════════════ 6.5. СТАТИСТИКА ПОЛЬЗОВАТЕЛЯ @@ -724,7 +719,7 @@ ✅ Документы ✅ Любой тип сообщения Telegram ---- +════════════════════════════════════════════════════════════════════════════ 7.2. СОЗДАНИЕ РАССЫЛКИ @@ -754,7 +749,7 @@ 2. Сообщение получат ВСЕ пользователи бота 3. Группы игнорируются ---- +════════════════════════════════════════════════════════════════════════════ 7.3. ОТПРАВКА СООБЩЕНИЯ @@ -781,7 +776,7 @@ ШАГ 4: Нажмите "✅ Да" или "❌ Нет" ---- +════════════════════════════════════════════════════════════════════════════ 7.4. ПРОЦЕСС РАССЫЛКИ @@ -802,7 +797,7 @@ • Причины: пользователь заблокировал бота, удалил аккаунт и т.д. • Рассылка может занять несколько минут для большого количества пользователей ---- +════════════════════════════════════════════════════════════════════════════ 7.5. СОВЕТЫ ПО РАССЫЛКЕ @@ -835,7 +830,7 @@ ✅ Делиться тестами с другими администраторами ✅ Создавать резервные копии тестов ---- +════════════════════════════════════════════════════════════════════════════ 8.2. ЭКСПОРТ ТЕСТА @@ -849,15 +844,15 @@ • Все варианты ответов • Правильные ответы • Типы вопросов - • Пароль теста - • Настройки попыток - • Лимит времени - • Группу ⚠️ ВАЖНО: Файл НЕ содержит: + ❌ Пароль теста + ❌ Настройки попыток + ❌ Лимит времени + ❌ Группу ❌ Результаты прохождений ---- +════════════════════════════════════════════════════════════════════════════ 8.3. ИМПОРТ ТЕСТА @@ -870,14 +865,189 @@ ✅ Создастся новый тест ✅ Все вопросы будут добавлены ✅ Тест будет деактивирован + ✅ Нужно будет настроить параметры (пароль, время и т.д.) + ⚠️ ВАЖНО: • Файл должен быть в правильном формате • Если файл повреждён - импорт не сработает • После импорта проверьте тест! ---- +════════════════════════════════════════════════════════════════════════════ -8.4. ИСПОЛЬЗОВАНИЕ ШАБЛОНОВ +8.4. ФОРМАТ JSON ФАЙЛА + +JSON файл теста имеет следующую структуру: + +{ + "title": "Название теста", + "description": "Описание теста", + "questions": [ + { + "text": "Текст вопроса", + "type": "single", + "options": [ + { + "text": "Вариант ответа 1", + "is_correct": true + }, + { + "text": "Вариант ответа 2", + "is_correct": false + } + ] + } + ] +} + +ОПИСАНИЕ ПОЛЕЙ: + +title (обязательное) + Название теста + Тип: строка + Максимум: 255 символов + Пример: "Тест по математике" + +description (обязательное) + Описание теста + Тип: строка + Максимум: 2000 символов + Пример: "Проверка знаний по алгебре" + +questions (обязательное) + Массив вопросов + Тип: массив объектов + Минимум: 1 вопрос + +СТРУКТУРА ВОПРОСА: + +text (обязательное) + Текст вопроса + Тип: строка + Максимум: 2000 символов + Пример: "Сколько будет 2+2?" + +type (обязательное) + Тип вопроса + Тип: строка + Возможные значения: + "single" - один правильный ответ + "multiple" - несколько правильных ответов + "input" - ввод текста + +options (обязательное для single и multiple) + Массив вариантов ответа + Тип: массив объектов + Минимум: 2 варианта для single/multiple + Для типа "input" должен быть ровно 1 вариант с правильным ответом + +СТРУКТУРА ВАРИАНТА ОТВЕТА: + +text (обязательное) + Текст варианта ответа + Тип: строка + Максимум: 255 символов + Пример: "Москва" + +is_correct (обязательное) + Является ли вариант правильным + Тип: boolean (true/false) + Для "single": только один вариант должен быть true + Для "multiple": один или несколько вариантов могут быть true + Для "input": единственный вариант должен быть true + +════════════════════════════════════════════════════════════════════════════ + +8.5. ПРИМЕРЫ JSON ФАЙЛОВ + +ПРИМЕР 1: Тест с одним правильным ответом + +{ + "title": "Столицы мира", + "description": "Проверка знаний столиц", + "questions": [ + { + "text": "Столица России?", + "type": "single", + "options": [ + {"text": "Москва", "is_correct": true}, + {"text": "Санкт-Петербург", "is_correct": false}, + {"text": "Казань", "is_correct": false} + ] + } + ] +} + +ПРИМЕР 2: Тест с несколькими правильными ответами + +{ + "title": "Математика", + "description": "Чётные числа", + "questions": [ + { + "text": "Выберите чётные числа", + "type": "multiple", + "options": [ + {"text": "2", "is_correct": true}, + {"text": "3", "is_correct": false}, + {"text": "4", "is_correct": true}, + {"text": "5", "is_correct": false} + ] + } + ] +} + +ПРИМЕР 3: Тест с вводом текста + +{ + "title": "География", + "description": "Знание столиц", + "questions": [ + { + "text": "Напишите столицу Франции", + "type": "input", + "options": [ + {"text": "Париж", "is_correct": true} + ] + } + ] +} + +ПРИМЕР 4: Полный тест с разными типами вопросов + +{ + "title": "Комплексный тест", + "description": "Разные типы вопросов", + "questions": [ + { + "text": "Столица России?", + "type": "single", + "options": [ + {"text": "Москва", "is_correct": true}, + {"text": "Киев", "is_correct": false} + ] + }, + { + "text": "Выберите простые числа", + "type": "multiple", + "options": [ + {"text": "2", "is_correct": true}, + {"text": "3", "is_correct": true}, + {"text": "4", "is_correct": false} + ] + }, + { + "text": "Сколько будет 5+5?", + "type": "input", + "options": [ + {"text": "10", "is_correct": true} + ] + } + ] +} + +════════════════════════════════════════════════════════════════════════════ + +8.6. ИСПОЛЬЗОВАНИЕ ШАБЛОНОВ Сценарии использования: @@ -896,6 +1066,13 @@ 2. Измените файл (другие вопросы) 3. Импортируйте как новый вариант +СЦЕНАРИЙ 4: Редактирование теста + 1. Экспортируйте тест + 2. Откройте JSON в текстовом редакторе + 3. Измените вопросы или ответы + 4. Сохраните файл + 5. Импортируйте обратно + ═══════════════════════════════════════════════════════════════════════════════ 9. ЧАСТЫЕ ВОПРОСЫ И РЕШЕНИЕ ПРОБЛЕМ ═══════════════════════════════════════════════════════════════════════════════ @@ -917,7 +1094,7 @@ 4. Студент исчерпал попытки Решение: Откройте тест → "✏️ Изменить" → "🔄 Попытки" → увеличьте или уберите ---- +════════════════════════════════════════════════════════════════════════════ ❓ Как изменить вопросы в уже созданном тесте? @@ -926,7 +1103,7 @@ Решение: 1. Экспортируйте тест ("📄 Шаблоны" → "📤 Экспорт") 2. Удалите старый тест - 3. Отредактируйте JSON файл (если умеете) + 3. Отредактируйте JSON файл 4. Импортируйте обратно ИЛИ @@ -935,7 +1112,7 @@ 2. Деактивируйте старый тест 3. Активируйте новый тест ---- +════════════════════════════════════════════════════════════════════════════ ❓ Студент не может начать тест. Пишет "Неверный пароль" @@ -952,7 +1129,7 @@ 2. Нажмите "🗑 Удалить пароль" 3. Теперь тест доступен без пароля ---- +════════════════════════════════════════════════════════════════════════════ ❓ Как посмотреть ответы конкретного студента? @@ -969,7 +1146,7 @@ ШАГ 3: Нажмите "📊 Статистика" ШАГ 4: Выберите нужный тест ---- +════════════════════════════════════════════════════════════════════════════ ❓ Студент говорит, что не видит результаты теста @@ -980,7 +1157,7 @@ 2. Нажмите "👁 Показать результаты" 3. Теперь студенты видят свои баллы и ответы ---- +════════════════════════════════════════════════════════════════════════════ ❓ Как удалить тест? @@ -991,7 +1168,7 @@ ⚠️ ВАЖНО: Удаление необратимо! Все результаты будут потеряны! ---- +════════════════════════════════════════════════════════════════════════════ 9.2. ВОПРОСЫ ПО ГРУППАМ @@ -1001,17 +1178,19 @@ Решение: • Студент должен сам указать свою группу при регистрации - • Или студент может изменить группу в главном меню + • Или студент может изменить группу через свой профиль в боте ---- +════════════════════════════════════════════════════════════════════════════ ❓ Что будет, если удалить группу? При удалении группы: ✅ Студенты останутся в боте + ✅ Студенты просто будут без группы + ✅ Тесты для этой группы станут доступны всем ❌ Данные студентов НЕ удаляются ---- +════════════════════════════════════════════════════════════════════════════ ❓ Можно ли переименовать группу? @@ -1022,7 +1201,7 @@ 2. Попросите студентов изменить группу в профиле 3. Удалите старую группу ---- +════════════════════════════════════════════════════════════════════════════ 9.3. ВОПРОСЫ ПО ПОЛЬЗОВАТЕЛЯМ @@ -1037,7 +1216,7 @@ • Не создавать для него тесты • Не добавлять в группы ---- +════════════════════════════════════════════════════════════════════════════ ❓ Пользователь не получает сообщения от бота @@ -1051,7 +1230,7 @@ 3. Проблемы с Telegram Решение: Подождите или попросите переустановить Telegram ---- +════════════════════════════════════════════════════════════════════════════ 9.4. ВОПРОСЫ ПО РАССЫЛКЕ @@ -1066,7 +1245,7 @@ Обычно доходит 90-95% сообщений. ---- +════════════════════════════════════════════════════════════════════════════ ❓ Можно ли отменить рассылку? @@ -1074,7 +1253,7 @@ Совет: Всегда проверяйте сообщение перед отправкой! ---- +════════════════════════════════════════════════════════════════════════════ ❓ Как сделать рассылку только одной группе? @@ -1083,7 +1262,7 @@ ШАГ 3: Нажмите "📤 Отправить выбранным" ШАГ 4: Отправьте сообщение ---- +════════════════════════════════════════════════════════════════════════════ 9.5. ТЕХНИЧЕСКИЕ ПРОБЛЕМЫ @@ -1094,7 +1273,7 @@ 2. Отправьте /start 3. Если не помогло - обратитесь к администратору сервера ---- +════════════════════════════════════════════════════════════════════════════ ❓ Кнопки не работают / не нажимаются @@ -1103,7 +1282,7 @@ 2. Отправьте /start 3. Обновите Telegram до последней версии ---- +════════════════════════════════════════════════════════════════════════════ ❓ Бот отправляет сообщения с задержкой @@ -1114,7 +1293,7 @@ Решение: Подождите несколько минут ---- +════════════════════════════════════════════════════════════════════════════ ❓ Потерялись данные / результаты тестов @@ -1145,7 +1324,7 @@ • Слишком лёгкие (угадываются) • С ошибками в тексте ---- +════════════════════════════════════════════════════════════════════════════ 10.2. НАСТРОЙКА ПАРАМЕТРОВ ТЕСТА @@ -1170,7 +1349,7 @@ • Устанавливайте для домашних заданий • Не устанавливайте для справочных материалов ---- +════════════════════════════════════════════════════════════════════════════ 10.3. ОРГАНИЗАЦИЯ РАБОТЫ @@ -1191,23 +1370,24 @@ • Экспортируйте статистику • Деактивируйте тест (если нужно) ---- +════════════════════════════════════════════════════════════════════════════ 10.4. БЕЗОПАСНОСТЬ ⚠️ Важные правила: -2. НЕ делитесь паролями от тестов публично -3. Регулярно проверяйте список администраторов -4. Сохраняйте резервные копии важных тестов -5. Не удаляйте тесты с важными результатами без экспорта +1. НЕ делитесь паролями от тестов публично +2. Регулярно проверяйте список администраторов +3. Сохраняйте резервные копии важных тестов +4. Не удаляйте тесты с важными результатами без экспорта +5. Проверяйте тесты перед активацией ═══════════════════════════════════════════════════════════════════════════════ 11. БЫСТРАЯ СПРАВКА - ОСНОВНЫЕ КОМАНДЫ ═══════════════════════════════════════════════════════════════════════════════ /start - Запуск бота / возврат в главное меню -/admin - Вход в панель администрирования +/admin - Открыть админ-панель (только для администраторов) ═══════════════════════════════════════════════════════════════════════════════ 12. КОНТАКТЫ И ПОДДЕРЖКА