docs/guide-user.md

247 lines
12 KiB
Markdown
Raw Normal View History

2026-02-07 15:20:02 +03:00
# Руководство пользователя
> AI Assistant — Telegram-бот для управления задачами с ИИ-анализом сообщений в групповых чатах.
Это руководство для обычных пользователей — тех, кому назначаются задачи. Вам не нужно настраивать бота или управлять проектами — достаточно знать, как просматривать свои задачи, менять их статус и получать уведомления.
---
## Оглавление
1. [Начало работы](#1-начало-работы)
2. [Главное меню](#2-главное-меню)
3. [Как вам назначают задачи](#3-как-вам-назначают-задачи)
4. [Просмотр своих задач](#4-просмотр-своих-задач)
5. [Работа с задачей](#5-работа-с-задачей)
6. [Фильтрация задач](#6-фильтрация-задач)
7. [Быстрый доступ к задачам из любого чата](#7-быстрый-доступ-к-задачам-из-любого-чата)
8. [Уведомления о дедлайнах](#8-уведомления-о-дедлайнах)
9. [Частые вопросы](#9-частые-вопросы)
---
## 1. Начало работы
### 1.1. Регистрация
Чтобы начать работу с ботом:
1. Найдите бота в Telegram по его username.
2. Нажмите **Start** или отправьте команду `/start`.
3. Бот автоматически зарегистрирует вас в системе.
**Важно:** вы должны написать боту хотя бы раз, иначе система не сможет назначать вам задачи.
### 1.2. Приветственное сообщение
После `/start` бот отправит приветствие с информацией о доступных функциях и покажет клавиатуру с кнопками.
---
## 2. Главное меню
После регистрации вам доступна кнопка:
| Кнопка | Описание |
|---|---|
| **📋 Задачи** | Открыть меню задач |
При нажатии на **📋 Задачи** откроется подменю:
| Кнопка | Описание |
|---|---|
| **📗 Мои задачи** | Список задач, назначенных на вас |
Если вам не назначено ни одной задачи, список будет пустым.
---
## 3. Как вам назначают задачи
Задачи могут быть назначены вам несколькими способами:
### 3.1. Автоматически из группового чата
Если бот мониторит групповой чат и кто-то напишет сообщение с упоминанием вашего `@username`:
```
аш_username подготовь отчёт до пятницы
```
Бот распознает это как задачу и назначит её на вас (автоматически или после подтверждения администратором, в зависимости от режима работы).
Также задача может быть создана, если кто-то ответит (reply) на ваше сообщение с указанием действия.
### 3.2. Вручную администратором
Администратор может создать задачу через бота и указать вас как исполнителя с помощью `@username`.
### 3.3. Уведомление о назначении
Когда на вас назначена новая задача, бот может прислать уведомление в личные сообщения.
---
## 4. Просмотр своих задач
### 4.1. Через меню
1. Нажмите **📋 Задачи** → **📗 Мои задачи**.
2. Бот покажет список задач со статусом «CREATED» (новые задачи).
### 4.2. Через команду
Отправьте боту в личные сообщения:
```
/my_tasks
```
### 4.3. Информация в карточке задачи
Для каждой задачи отображается:
- **ID** и **название**
- **Статус** (CREATED, IN_WORK, BLOCKED, FINISHED, CANCELLED)
- **Описание** (если есть)
- **Дедлайн** (если установлен)
- **Исполнители** (список `@username`)
---
## 5. Работа с задачей
### 5.1. Открытие задачи
Нажмите на задачу в списке. Откроется карточка с полной информацией и кнопками управления.
### 5.2. Изменение статуса
Это основное действие, доступное вам. Вы можете менять статус задачи:
| Статус | Когда ставить |
|---|---|
| **CREATED** | Задача только создана (начальный статус) |
| **IN_WORK** | Вы начали работать над задачей |
| **BLOCKED** | Работа заблокирована (ожидание, внешние зависимости) |
| **FINISHED** | Задача выполнена |
| **CANCELLED** | Задача отменена |
Нажмите **Изменить статус** и выберите нужный.
### 5.3. Что происходит при завершении задачи
Когда вы ставите статус **FINISHED**:
- Ответственному лицу (тому, кто создал задачу) автоматически создаётся задача на проверку.
- Он получит уведомление: «Исполнитель отметил задачу #N как выполненную».
- Уведомления о дедлайне этой задачи отключаются.
### 5.4. Другие доступные действия
В зависимости от задачи вам также могут быть доступны:
| Действие | Описание |
|---|---|
| Изменить название | Ввести новое название задачи |
| Изменить описание | Ввести новое описание |
| Изменить дедлайн | Формат: `ДД.ММ.ГГГГ` или `+3` / `-1` (сдвиг в днях) |
| Изменить людей | Добавить `@username` или убрать исполнителя |
---
## 6. Фильтрация задач
При просмотре своих задач вы можете фильтровать их двумя способами:
### 6.1. По статусу
Нажмите кнопку нужного статуса под списком задач:
- CREATED
- IN_WORK
- BLOCKED
- FINISHED
- CANCELLED
### 6.2. По дате дедлайна
Отправьте дату в формате `ДД.ММ.ГГГГ`:
```
15.04.2025
```
Бот покажет только задачи с дедлайном в указанный день.
---
## 7. Быстрый доступ к задачам из любого чата
Вы можете получить список своих задач прямо из любого чата Telegram с помощью инлайн-запроса.
### Как это работает:
1. В **любом** чате (даже в другом диалоге) начните вводить:
```
@имя_бота Задачи
```
2. Появится выпадающий список ваших задач.
3. Нажмите на задачу — и информация о ней будет отправлена в текущий чат.
Это удобно, когда нужно быстро поделиться информацией о задаче с коллегой.
---
## 8. Уведомления о дедлайнах
Бот автоматически уведомляет о приближающихся дедлайнах:
- **За день до дедлайна** — напоминание о том, что срок подходит к концу.
- **В день дедлайна** — уведомление о наступлении срока.
Уведомление содержит:
- ID и название задачи
- Дату дедлайна
- Текущий статус задачи
При получении уведомления вы можете нажать **Подробнее о задаче**, чтобы открыть карточку задачи.
**Примечание:** если задача завершена (статус FINISHED), уведомления о дедлайне отключаются автоматически.
---
## 9. Частые вопросы
### Я не вижу никаких задач
- Убедитесь, что вы написали боту `/start` хотя бы раз.
- Возможно, вам ещё не назначены задачи. Уточните у администратора.
- Проверьте фильтр по статусу — возможно, выбран статус, по которому нет задач.
### Мне не приходят уведомления
- Убедитесь, что вы не заблокировали бота в Telegram.
- Уведомления настраивает администратор. Возможно, они отключены.
### Бот не распознаёт мой @username в чате
- Проверьте, что вы написали боту `/start` — это необходимо для регистрации.
- Убедитесь, что у вас установлен username в настройках Telegram.
### Как узнать, кто создал задачу?
- В карточке задачи может быть указан создатель. Если нет — уточните у администратора.
### Я случайно поставил статус FINISHED
- Откройте задачу и измените статус обратно на нужный (например, IN_WORK).
- Учтите, что при переводе в FINISHED уже создана задача на проверку — администратор получил уведомление.
### Как мне связаться с администратором бота?
- Обратитесь к тому, кто добавил бота в ваш рабочий чат — это администратор или суперадминистратор системы.
---
## Краткий справочник
| Действие | Как сделать |
|---|---|
| Открыть меню | `/start` в ЛС с ботом |
| Мои задачи | `/my_tasks` или **📋 Задачи** → **📗 Мои задачи** |
| Инлайн-запрос задач | `@имя_бота Задачи` в любом чате |
| Фильтр по статусу | Кнопки под списком задач |
| Фильтр по дате | Отправить дату в формате `ДД.ММ.ГГГГ` |
| Изменить статус задачи | Открыть задачу → Изменить статус |