Настройка Комедиана для PMов и админов - maddevsio/comedian GitHub Wiki

Введение: Комедиан и стэндапы

На данный момент Комедиан не предназначен для отслеживания качества стэндапов.

Сейчас Комедиан определяет стэндапы по простым ключевым словам (вчера/в пятницу, сегодня, проблемы/вопросы). Если они есть в тексте, Комедиан будет думать, что это стэндап. Это сделано для того, чтобы стэндапер не заморачивался над определенной структурой, или размером своего стэндапа. Такую систему легко "обмануть", просто написав "вчера, сегодня, проблемы", но все должны понимать, что такой стэндап никуда не годится и не приведет к нужным результатам.

Поэтому стоит предупредить будущих стэндаперов о правилах написания стэндапов и оставить качество стэндапов на их совести. Комедиан при этом будет выполнять свою работу, а именно отмечать грачей в чате, напоминать о необходимости писать стэндапы тем, кто их не написал и помогать ПМам в их работе по решению проблем коллектива с помощью разных отчетов.

Перед настройкой:

Пригласите комедиана в канал проекта, иначе он не сможет ничего сделать в канале

Шаг 1: настройте дедлайн для сдачи стэндапов в канале

Установить время стэндапов в канале с помощью слэшкоманды /standup_time_set чч:мм (21:02)

Посмотреть, на какое время установился дедлайн можно с помощью слэшкоманды /standup_time

Удалить время для стэндапов можно с помощью слэшкоманды /standup_time_remove

Когда время для стэндапов установлено, комедиан в это время будет отмечать тех, кто не написал стэндап в период с 00:00 текущего дня до указанного вами времени. За 10 минут до дедлайна высылается уведомление, что нужно писать стэндап. Уведомление высылается только тем, кто не написал его до дедлайна, всех остальных (кто уже написал) бот не отмечает.

Если все написали стэндапы, комедиан отправит в группу соотвествующее сообщение. Если есть те, кто не написал, комедиан будет высылать напоминания о том, что нужно писать стэндап каждые 30 минут. После третьего напоминания комедиан остановится, но в итоге можно сдать стэндап до конца дня, чтобы он зафиксировался в базе.

У всех кто не сдал стэндап до 23:50 создадутся пустые стэндапы, которые в последующем будут ориентиром для менеджеров, показывая тех, кто не сдал стэндапы.

Шаг 2: добавьте разработчиков, которые должны писать стэндапы

Чтобы управлять стэндаперами канала нужно воспользоваться следующими командами:

/comedian_add @username @username2 - добавляет пользователей (можно добавить от одного и больше пользователей)

/comedian_remove @username @username2 удалит стэндаперов из канала, в случае необходимости (можно удалить от одного и больше пользователей)

/comedian_list покажет всех, кто должен сдавать стэндапы на текущий момент

Шаг 3: Устанавливайте индивидуальное рассписание стэндапов

Когда вам необходимо, чтобы кто-то писал стэндапы не по общему расписанию (например каждое утро в 10:30) вы можете это сделать с помощью слэшкоманды timetable. Она создаёт индивидуальное расписание стэндаперу и комедиан будет воспринимать такого пользователя по-другому: не будет замечать его по общему рассписанию)

/timetable_set @userA @userB по пн вт ср чт пт сб вс в 12:00 задаёт userA и userB индивидуальные графики стэндапов по всем дням недели в 12:00 (английский вариан: on mon tue wed thu fri sat sun at) Можно устанавливать свободный график просто задав время числом "0" вместо какого-то конкретного времени.

/timetable_remove @userA @userB удалит графики для пользователей, при этом они начнут стэндапить по общему графику их проекта

/timetable_show @userA @userB покажет индивидуальные графики стэндапов для выбранных пользователей

Пользуйтесь!

Комедиан будет напоминать пользователям в общем чате каждый день кроме выходных. Он так же будет напоминать о пропущенных стэндапах за 10 минут до дедлайна в чате проекта, а так же писать вам о том, кто не сдал стэндапы в ЛС после всех напоминаний в чате проекта. Можете удалять стэндаперов и менять время сдачи стэндапов когда вам угодно.

После написания сообщения, комедиан ждет 2-3 секунды и если стэндап принят и сохранён в базе данных, комедиан ставит реакцию на сообщение (:checkmark:), а так же уведомляет автора стэндапа, что он принят. Если стендап не содержит каких-либо обязательных ключевых слов, бот напишет автору, что у него отсутствует.

Комедиан может предоставлять 3 вида отчетов. Каждому виду отчёта нужно указать даты с какого по какой день нужен отчёт. Если хотите получить отчёт только за сегодняшний или только за вчерашний день, указывайте две одинаковые даты, например: 2018-09-20 2018-09-20 выведет отчёт за 20 сентября.

по проекту (формат слэшкомады: /report_by_project #названиепроекта 2018-09-01 2018-09-20) по пользователю (формат слэшкомады: /report_by_user @имяпользователя 2018-09-01 2018-09-20) по пользователю в проекте (формат слэшкомады: /report_by_project_and_user #названиепроекта @имяпользователя 2018-09-01 2018-09-20)

Если вы суперадмин, то можете редактировать список админов:

/admin_add @имяпользователя - добавлят нового ПМа в канал /admin_remove @имяпользователя - удаляет ПМа из канала /admin_list - показывает список всех ПМов канала

Всё взаимодействие (настройка и отчетность) с комедианом проходит приватно, т.е. другие не будут видеть все ненужные сообщения Комедиана в группе (канале)

По всем вопросам настройки или замечаниям по багам обращайтесь к Анатолию ([email protected] / 0552 22 98 05)