Ты разработчик чатботов. Тебе нужно написать рекомендации по описанию задач в Jira,…
- User
Ты разработчик чатботов. Тебе нужно написать рекомендации по описанию задач в Jira, которые предоставляет заказчик. Дай перечень рекомендаций для заказчика, которые помогут ему более качественно составлять задачи в Jira, а твоей команде - лучше понимать его требования
- Assistant
Создание чётких и понятных задач в Jira – важный шаг для обеспечения эффективной работы команды разработчиков. Вот несколько рекомендаций для заказчиков, которые помогут улучшить качество описания задач:
-
Четкое и однозначное название: Используйте информативное название, которое сразу даёт представление о задаче. Избегайте общих формулировок.
-
Комплексное описание: Включите полное описание задачи с объяснением цели, ожидаемого результата и ключевых требований. Убедитесь, что описание находится в контексте общего проекта.
-
Используйте шаблоны: Разработайте и следуйте шаблонам для задач, чтобы стандартизировать формат и содержание. Это может включать разделы для цели, требований, зависимостей и критериев приёмки.
-
Критерии приёмки: Чётко укажите, какие условия должны быть выполнены для успешного завершения задачи. Это поможет избежать недопонимания и улучшит качество итогового продукта.
-
Приоритет и сроки: Укажите приоритет задачи и, если это применимо, крайний срок выполнения. Это поможет команде правильно расставлять акценты между задачами.
-
Детализируйте требования: Используйте конкретные и измеримые требования, избегайте двусмысленных формулировок. Если возможно, приложите дополнительные материалы, такие как скриншоты, ссылки или схемы.
-
Обсуждение и вопросы: Обеспечьте возможность для обсуждения задачи в комментариях. Будьте готовы быстро отвечать на вопросы команды, чтобы избежать задержек.
-
Обозначьте связь с другими задачами: Укажите связи и зависимости с другими задачами или эпиками. Это позволит лучше понять контекст и определить правильный порядок выполнения задач.
-
Роли и ответственные: Назначьте конкретных лиц, ответственных за задачу, и обозначьте их роли. Это поможет избежать недоразумений в распределении ответственности.
-
Обратная связь и доработки: Будьте открыты к обсуждению и корректировке требований. Установите процесс для внесения изменений и предоставления обратной связи по выполнению задачи.
Соблюдение этих рекомендаций поможет сделать процесс работы более прозрачным и эффективным как для заказчика, так и для команды разработчиков.
-
- User
дай больше конкретики и подробностей по пунктам 2, 4 и 6
- Assistant
Конечно, давайте подробнее рассмотрим пункты 2, 4 и 6.
2. Комплексное описание
-
Цель задачи: Начните с объяснения, почему эта задача важна и какую проблему она решает. Опишите бизнес-контекст, чтобы разработчики понимали, как их работа вписывается в общий проект.
-
Конечный результат: Укажите, каким должен быть результат работы. Это может включать изменения в пользовательском интерфейсе, новую функциональность или улучшение производительности.
-
Ключевые функции и особенности: Опишите, какие функции должны быть реализованы, какие технические или функциональные ограничения существуют. Если задача техническая, уточните, какие технологии или подходы должны быть использованы.
-
Требования к дизайну и пользовательскому интерфейсу: Если задача включает изменение интерфейса, приложите макеты, схемы или исчерпывающие описания изменений в UI.
-
Примеры: Если возможно, предоставьте примеры аналогичных решений или сценарии использования, которые помогут разработчикам лучше понять требования.
4. Критерии приёмки
-
Четкость и измеримость: Определите конкретные параметры выполнения задачи, которые можно проверить. Например, описать, что функция должна работать в определённых браузерах или иметь время отклика не более определённого значения.
-
Тестовые сценарии: Включите основные тестовые сценарии: какие действия должны быть предприняты и какой результат должен получиться. Это поможет как команде контроля качества, так и разработчикам понять ваши ожидания.
-
Условия готовности: Уточните, какие моменты должны быть завершены, чтобы задача считалась решённой. Это могут быть определённые условия внешнего вида, производительности, совместимости и отсутствия ошибок.
6. Детализируйте требования
-
Ясность и отсутствие двусмысленности: Избегайте обобщённых или двусмысленных терминов. Вместо "улучшить производительность" напишите: "сократить время загрузки страницы до 2 секунд при 1000 одновременных пользователей".
-
Измеримые характеристики: Описывайте параметры, которые можно измерить: проценты, количество операций в секунду, конкретные данные по пропускной способности.
-
Визуальные дополнения: Приложите диаграммы, схемы, пользовательские потоки или скриншоты, чтобы наглядно продемонстрировать, как должно выглядеть решение.
-
Обязательные и желательные требования: Четко разграничьте, какие требования являются критичными для выполнения задачи, а какие — желательными, но необязательными. Это поможет команде расставить приоритеты в случае временных или ресурсных ограничений.
Проработка этих аспектов поможет создать более понятные и реализуемые задачи, что значительно увеличит шансы на успешное выполнение работы в нужные сроки.
-
- User
Я сделал аналогичное задание. Мне нужно, чтобы ты провел ревью моего документа и помог его структурировать, а также убрать оттуда грубые формулировки и ошибки
- Название
- Корректное название. Если есть влияние на конкретный сценарий или сценарии - указать это. Плохой пример: https://jira.iqos.ru/browse/CP-2095, https://jira.iqos.ru/browse/CP-2028
- Название задачи должно кратко и четко описывать ее назначение. Т.е. задачу https://jira.iqos.ru/browse/CP-2028 можно было бы назвать “HCC. Create outgoing call to BPM/CRM via API”
- Описание
- Полное описание того, что должно быть сделано
- Проекты, на которые должно оказываться влияние
- Названия блоков и стейтов - согласно сценарию в Miro. То есть не “на вопросе, где бот спрашивает с чем совмещаете”, а в стейте “OnlyDevice/Combine”
- Примеры
- Если изменения сценария - пример того, как должен выглядеть диалог после изменений
- Если реализация или изменения http-запроса - пример корректного запроса с пояснениями
- Примеры сессий - ссылками, а не ID сессии или время и номер
- Изменения требований должны фиксироваться не только в комментариях, но и изменениями описания
- Описание должно быть написано грамотно)
- Документы
- Документы, особенно если это сложные и большие таблицы - должны сопровождаться пояснением, как это сопоставлять со сценарием или API. Например, в https://jira.iqos.ru/browse/CP-1996 и особенно https://jira.iqos.ru/browse/CP-2084 с нашей стороны было сложно прочитать документы
- В документах должно быть конкретно то, что необходимо для задачи. В идеале - ничего лишнего и все нужное.
Примеры плохого:
- В https://jira.iqos.ru/browse/CP-1996 была передана таблица с лишними полями, например Category Code
- В https://jira.iqos.ru/browse/CP-2084 была передана таблица с перечнем вопросов, которую было сложно расшифровать. Что означают там code вопросов, после чего уже становилось понятно, как переформировать таблицу.
- API
- Название
- URL
- Эндпоинты
- (2.с.ii) - Пример корректного запроса с пояснениями, какое поле:
- константа
- поле, зависящее от данных других http-запросов
- от действий клиента в сценарии
- в каких случаях отправляется, т.е. какие условия должны быть выполнены для отправки запроса
- Название
- Assistant
Вот более структурированная и отредактированная версия вашего документа с более мягкими формулировками:
Рекомендации по описанию задач в Jira
1. Название
-
Корректное название: Название задачи должно четко отражать её суть и влияние на конкретные сценарии, если таковые имеются. Избегайте неинформативных названий.
- Пример плохой практики: [Jira Issue ID]
- Пример хорошей практики: “HCC. Create outgoing call to BPM/CRM via API”
-
Лаконичность и ясность: Заголовок задачи должен быть кратким и четко описывать её назначение.
2. Описание
-
Полное описание задачи: Приведите детальное описание того, что необходимо выполнить. Это поможет команде лучше понять задачу.
-
Влияние на проекты: Укажите, на какие проекты или компоненты задачи окажут влияние.
-
Использование терминологии: Используйте названия блоков и состояний в соответствии с утверждённым сценарием (например, в Miro). Это позволяет избежать путаницы.
- Пример: Используйте стейты такие как “OnlyDevice/Combine” вместо описательных выражений.
-
Предоставление примеров:
- Для сценариев: Приведите конкретные примеры ожидаемого диалога.
- Для HTTP-запросов: Приведите пример корректного запроса с пояснениями.
- Для примеров сессий: Приводите ссылки на сессии, а не только ID или временные метки.
-
Актуализация требований: Любые изменения в требованиях должны отражаться не только в комментариях, но и в основном описании задачи.
-
Грамотное изложение: Убедитесь, что описание задачи написано грамотно и соответствует стандартам языка.
3. Документы
-
Пояснительные записки к документам: Документы, такие как таблицы, должны снабжаться пояснением о том, как они соотносятся с сценарием или API.
-
Четкость и релевантность данных: В документах должно содержаться только то, что необходимо для выполнения задачи, без лишних данных.
- Примеры, требующие улучшений:
- В случае [Jira Issue ID] была передана таблица с избыточными полями.
- В случае [Jira Issue ID] была сложность с расшифровкой таблицы. Рекомендация — упростить таблицу до необходимых полей и обеспечить ясную сопоставимость с текущими сценариями.
- Примеры, требующие улучшений:
4. API
-
Название и URL: Укажите название и URL, относящиеся к API.
-
Эндпоинты: Описание конечных точек должно быть вместе с пояснениями.
-
Примеры запросов: Приведите пример корректного запроса вместе с пояснениями:
- Какие поля являются константами;
- Какие поля зависят от других HTTP-запросов;
- Какие от действий клиента в конкретном сценарии.
-
Условия отправки: Укажите условия, при которых запрос должен быть отправлен.
Эти рекомендации помогут повысить качество описания задач, упрощая командное взаимодействие и выполнение проектов.
-
- User
Знаешь ли ты JAICP
- Assistant
Да, JAICP (Just AI Conversational Platform) - это платформа для создания и управления чатботами и голосовыми помощниками. Она предоставляет инструменты для разработки сценариев, анализа и улучшения взаимодействия с пользователями. Платформа поддерживает интеграцию с различными мессенджерами, сайтами и устройствами, что позволяет разрабатывать универсальные решения для бизнеса. Также JAICP обычно включает в себя возможности для обработки естественного языка (NLP), управления диалогами и объединения с внешними API.
- User
Знаешь ли ты JAICP DSL
- Assistant
Да, JAICP DSL (Domain-Specific Language) — это специально разработанный язык, который используется в платформе JAICP (Just AI Conversational Platform) для создания сценариев чатботов и голосовых помощников. Этот язык позволяет разработчикам формулировать логику взаимодействия в удобочитаемом текстовом формате, задавать правила управления диалогами и обрабатывать пользовательские вводы. JAICP DSL обеспечивает разработчикам возможность легко моделировать сложные сценарии и интегрировать их с внешними системами, упрощая процесс создания интеллектуальных разговорных агентов.
- User
Напиши мне бота на JAICP DSL, который проверяет, авторизован ли пользователь в сторонней системе, и если он авторизован, предлагает задать вопрос. Заданный вопрос бот фиксирует в аналитику и закрывает сессию
- Assistant
Создание бота на JAICP DSL для проверки авторизации пользователя и фиксации заданного вопроса в аналитике может выглядеть следующим образом. Этот пример включает сценарий, в котором бот спрашивает пользователя об авторизации в сторонней системе и фиксирует вопрос в аналитике, если пользователь авторизован:
start: // Начальная точка диалога // Проверяем авторизацию пользователя intent { // Предположим, что есть внешний API или функция, проверяющая авторизацию matches: /я авторизован/ action { jump authorized } } // Если пользователь не авторизован, предлагаем авторизоваться // В реальности добавьте здесь проверку через API или другую процедуру body: "Вы не авторизованы. Пожалуйста, выполните авторизацию." authorized: // Если пользователь авторизован, мы предлагаем задать вопрос body: "Вы авторизованы. Пожалуйста, задайте свой вопрос." context: expect_question expect_question: // Ожидаем вопрос от пользователя intent { // Любая фраза будет считаться вопросом matchers: any action { // Фиксируем вопрос в аналитике // Здесь 'analytics.log' - это пример, замените на фактический метод записи в аналитику analytics.log("user_question", { "question": request.originalUtterance }); // Подтверждаем, что вопрос получен reactions.say("Ваш вопрос зафиксирован. Спасибо!") // Завершаем сессию reactions.gotoEnd() } } // Обработка иных случаев, на случай если вопрос не получен body: "Не удается зафиксировать ваш вопрос. Попробуйте еще раз."Объяснения
-
start state: Начальная точка диалога, где бот определяет, авторизован ли пользователь. Здесь вместо условного текста "я авторизован", вы бы добавили реальный API вызов или данные для проверки авторизации.
-
authorized state: Когда пользователь авторизован, бот побуждает задать вопрос.
-
expect_question state: Этот блок обрабатывает любой полученный вопрос, записывает его в аналитику и подтверждает фиксацию вопроса, после чего сессия завершена.
Обратите внимание, что фактическая реализация может потребовать интеграции с реальными API или системами аутентификации, а также использования подходящих функций для записи данных в аналитику в вашей конкретной среде JAICP.
-
- User
Скинь мне документацию на используемый тобой язык/фреймворк
- Assistant
Я не имею возможности напрямую предоставлять ссылки или файлы, но вы можете найти документацию по JAICP DSL на официальном сайте платформы Just AI. Обычно, там доступны разделы, посвященные созданию сценариев, управлению диалогами и интеграции с внешними системами. Если у вас есть доступ к платформе, попробуйте искать следующие ресурсы:
-
Документация разработчика: Здесь вы можете найти подробное руководство по использованию JAICP DSL, включая синтаксис и примеры кода.
-
Примеры использования: Официальные примеры проектов или сценариев, которые могут быть полезны для начала работы.
-
Обучающие материалы и руководства: Вебинары, видеоуроки или статьи на блоге Just AI часто содержат примеры и объяснения.
-
Форумы и сообщества: Могут быть полезны для получения совета от других разработчиков, работающих с JAICP.
Я рекомендую посетить официальный сайт Just AI или связаться с их поддержкой для получения самой актуальной информации.
-