update documentation

README.md

@@ -1,14 +1,16 @@
 # RandomCoffeeBotTelegram
 Random Coffee bot for the Telegram
 
+#### Проект телеграм-бота, который предоставляет возможность пообщаться с IT-специалистами - выпускниками разных IT направлений практикума.
+
 # Содержание
 
 
-1. [БРИФ](#brief)
+1. [БРИФ](docs/materials/briff.md)
 
-   1.1 [Инструкции и ритуалы на проекте]()
+   1.1 [Инструкции и ритуалы на проекте](docs/materials/instructions.md)
 
-   1.2 [ER - диаграмма сущностей](#er)
+   1.2 [ER - диаграмма сущностей](docs/RandomCoffeeER.jpg)
 
 2. [Структура проекта](#structure)
 3. [Подготовка к запуску](#start)
@@ -31,12 +33,6 @@ Random Coffee bot for the Telegram
 
 <br><br>
 
-# 1. БРИФ <a id="brief"></a>
-
-## 1.2. ER - диаграмма сущностей<a id="er"></a>:
-ER диаграммы расположены в директории /docs в двух удобных форматах [.drowio, .jpg]
-![ER Диаграмма](/docs/RandomCoffeeER.jpg)
-
 # 2. Структура проекта <a id="structure"></a>
 
 | Имя  | Описание |
@@ -308,7 +304,3 @@ make filldb
 данными. Но, как правило, рекомендуется тестировать все написанные
 самостоятельно основные функции бота, функции отправки и получения сообщений,
 функции перенаправления на сторонние или внутренние ресурсы.
-
-#### Рекомендации к написанию кода [Codestyle](https://github.com/Studio-Yandex-Practicum/RandomCoffeeBotTelegram/tree/develop/docs/codestyle.md)
-
-#### Диаграмма логики работы бота [Diagram](https://github.com/Studio-Yandex-Practicum/RandomCoffeeBotTelegram/tree/develop/docs/Diagramm_of_bot_logic.drawio)

docs/materials/briff.md

@@ -0,0 +1,25 @@
+# Бриф
+
+**Цель проекта:** Обеспечить процесс формирования пар для Random Coffee между студентами курса IT-рекрутер и выпускниками IT-специальностей Практикума в Telegram
+
+**Задачи:**
+
+Создать Телеграм-бота.
+
+
+## Описание телеграм-бота:
+
+### [Схема состояний](https://github.com/Studio-Yandex-Practicum/RandomCoffeeBotTelegram/blob/develop/docs/Diagramm%20of%20bot%20logic.jpg) - визуальное изображение стейтов
+
+Ожидаемая функциональность:
+
+* создание профиля (учетной записи) каждого участника и хранение его в базе данных
+* создание пары между выпускником и рекрутером (нужно, чтобы бот не создавал * пары типа рекрутер-рекрутер или выпускник-выпускник)
+* рассылка контактов собеседников после создания пары
+* запрос обратной связи у участников (отправляет ссылку на форму)
+* повторный вопрос о создании пары после первого участия
+* режим администратора должен включать: сброс пар, запрос статистики по парам, удаление профилей (возможно, другие функции по администрированию бота и участников)
+
+
+### Начало работы:
+Пользователь заходит в телеграмм и вводит в поисковую строку **@название бота ,** кликает по найденному боту, видит краткое описание, нажимает кнопку menu, после чего появляется окно с 3 кнопками: Поддержка, Старт, Помощь. При нажатии на кнопку старт бот предлагает поучаствовать в неформальном разговоре с выпускником Практикума.

docs/materials/instructions.md

@@ -0,0 +1,61 @@
+# Инструкции
+
+### Общие правила коммуникации на проекте
+
+1. Рабочее время: распределение времени с пн-вс для студентов, пн-пт для PM и TL, но для решения важных вопросов можно связаться и в выходные:
+
+   PM - с 12:00 до 22.00 по мск;
+   TL Константин Райхерт - с 16.00 до 23.00 по мск;
+
+   - Работаем  недельными спринтами (далее по скорости разработки).
+   - Стендапы понедельник, среда, пятница
+   - Еженедельные встречи с тимлидами один на один.
+   - В середине спринта (вт-чт) груминг задач для формирования бэклога на следующий спринт.
+
+2. Каналы коммуникации:
+    - пачка **Random_coffee_recruiter_bot_general**  - анонсы и stand up
+
+3. Notion - место для базы
+
+### Ритуалы
+
+1. **Письменный стендап**
+
+Когда: понедельник, среда, пятница до 19:00
+Где: в тредах к сообщению в пачке
+Цель: собрать актуальную информацию о положении дел в команде, выявить направления, требующие проработки тимлидами/техлидами/кураторами
+Как: написать сообщение по установленному формату в треде в пачке. (ПМ создает тред с утра)
+
+2. **Встреча one-to-one**
+
+Когда: по необходимости
+Где: по видео, один на один с тимлидом
+Цель: решить вопросы вызывающие стопор, обменяться опытом.
+Как: участник команды договаривается о созвоне лично с тимлидом.
+
+3. **Ретро**
+
+Когда: по итогам спринта
+Где: по видео
+Цель: улучшение командных процессов за счет обсуждения предыдущих событий и процессов в команде, которые наблюдались в течение спринта
+Как: вместе анализируем спринт и отвечаем на вопросы:
+
+- Плюсы. Что шло хорошо в прошлой итерации?
+- Минусы. Какие проблемы были в прошлой итерации?
+- Идеи. Какие идеи появились по ходу ретроспективы?
+- План. Какие улучшения мы запланируем на следующую итерацию?
+(если необходимо, закрепить ответственного за конкретные события)
+
+4. **Организация встреч в Zoom**
+
+    1. Описание встречи
+    2. Цели
+    3. Фиксированный тайминг
+    4. Запись при необходимости
+
+5. **Стендап (в письменном формате)**
+- Что делал вчера:
+- Что буду делать сегодня:
+- Какие есть вопросы/проблемы (тегай того, с кем конкретно хочешь переговорить):
+    *Если вопросов/проблем нет, так и пишешь, что их нет*
+- Предложения/пожелания: