Links

Правила оформления отчёта к задаче

Обзор

1) Отчёт пишется обязательно для оценённых задач и для задач с типом 🐞 Баг
2) Отчёт заполняется перед переводом в статус code review или выполненная
3) Если вы не заполнили отчёт по задаче, то Робот startmedia напомнит вам об этом и переведёт задачу на статс Корректировки.
4) Отчёт должен отвечать на вопрос: "Что сделано и где?"

Введение

Каждый клиент нашей компании оплачивает все заказанные работы и услуги по документу Акт выполненных работ. В данном документе всегда отражается перечень работ, которые были выполнены в спринт или за промежуток времени. Детализация выполненных задач, помогает менеджеру проектов быстрее сдать работу и быстрее получить оплату за оказанные услуги.
Отчёт который вы заполняете по выполненной задаче, попадает напрямую в документы предназначенные на подписание. Следовательно, тот отчёт который вы написали видит непосредственно сам клиент.
Отчёт по задаче не должен описывать все действия которые вы совершали, он должен описывать достигнутые цели по задаче!

1) Когда пишется отчёт?

Отчёт заполняется всегда перед переводом задачи в статус Code Review или Выполненная. Если вы забыли заполнить отчёт то задача вернётся в статусе Корректировки, а в комментарии к задаче вам напишет робот startmedia:
Робот твой друг и помощник.
Отчёт пишется к задачам в которых заполнены поля Часы Исполнителя и все задачи с типом 🐞 Баг
То есть, если у вас задача с заполненным полем Часы Исполнителя имеет подзадачи, но подзадачи при этом не оценены, то вы пишете отчёт только в родительской задаче.
Если вы сомневаетесь, нужно писать отчёт к задаче или нет, просто переведи задачу в статус Code Review или Выполненная и робот startmedia подскажет вам.

2) Отчёт должен отвечать на вопрос Что сделано и где?

Так как отчёт по задачи который вы пишете, попадает в печатные документы для клиента, нужно соблюдать некоторые правила написания:
Текст отчёта не должен содержать в себе ссылки на страницы или ссылки на скриншоты или сами скриншоты. В отчёте должен быть только текст!
Отчёт должен быть очень компактный максимум 1-2 предложения.
Вы пишите отчёт о уже проделанной работе, поэтому нужно описывать сделанную работу в прошедшем времени:
  • Разработана функция.....
  • Добавлена страница.....
  • Скрыта информация.....
  • Изменён текст в.....
  • Интегрирован сервис.....
В тексте отчёта должно быть явно указано в каком разделе или блоке или на какой странице вы вносили изменения. Нужно указывать именно названия блоков и разделов, а не вставлять ссылки на них. На крайний случай вы можете указать раздел сайта так: /catalog/dymososy/

Конструкция текста отчёта:

действие
что
где
Добавлена
функция сортировки товара
в разделе каталог.
Разработан
функционал фильтрации доступного для покупки товара
в каталоге.
Интегрирован
расчет доставки DPD
на страницу оформления заказа.
Разблокирован
доступ
к разделу /bitrix/catalog_export/
НЕЛЬЗЯ писать: я сделал, заменил, установил. на бою, добавлен класс eq-header
Нужно стараться описывать отчёт по задаче с точки зрения достигнутого результат или цели.