Как написать отчет о программе

Создание понятных отчетов о тестировании

Введение

Данная статья будет полезна для специалистов не только в тестировании, но и из других областей.
Я думаю, все понимают, что отчётность — это, зачастую, та часть, которая обязательна на проекте, но составлять ее всегда проблематично. Каждый, рано или поздно, сталкивается с проблемой «как это описать?», «что написать?» и главное «зачем и кто это будет читать?».
На самом деле, отчет — это важная и лаконичная форма передачи информации от исполнителя к заказчику. Это ответ на его технические требования и одновременно информация о проделанной работе.
Сегодня мы поговорим об отчетах в тестировании. В статье Вы найдет акценты на важные моменты при создании отчётов.

Понятный отчёт о тестировании

Создание понятного отчёта о тестировании (test-report) на практике.

Для начала, давайте вспомним определение:
Отчёт — это документ, содержащий информацию о выполненных действиях, результатах проведённой работы. Обычно он включает в себя таблицы, графики, списки, просто описывающую информацию в виде текста. Их пропорция и содержание определяют пользу и понятность отчета.
Нам важно понять, для кого, для чего и в каких условиях мы это делаем и на сколько это улучшит восприятие излагаемой нами информации. Надо помнить, что каждое действие преследует определенную цель. В случае отчета нам важно понять, для кого, для чего и в каких условиях мы это делаем.
Давайте посмотрим на схему:

Аналитические разрезы – это и есть наш отчет. В нем мы даем анализ нашей работе и оценку тестируемому продукту.
Вид компании, в идеальной ситуации, не должен влиять на качество и смысловую ёмкость отчетности. В реальном же мире, к сожалению, отчетность аутсорсинговых компаний является, как правило, более качественной и емкой, чем отчетность штатных отделов тестирования (бывают и приятные исключения).
Мы, как и любая другая аутсорсинговая компания, вынуждены уделять большое внимание качеству и прозрачности отчетности, потому что она является ключевой видимой заказчику метрикой оценки нашей работы.
Саму отчетность можно разделить на финальную и регулярную – дневную, недельную, месячную, версионную (для каждой версии продукта) и т.п. Различия заключаются в глубине временнОй выборки.
Итак, перед написанием отчета, сначала нам надо определиться для кого мы его пишем.

Для кого формируем отчет?

При создании отчета важно понимать, для кого он создаётся, и кто будет его читать.
Исходя из приоритетов целевой аудитории, мы должны определить, какую информацию должен содержать отчёт. Соответственно, в ходе проекта, информация должна консолидироваться по тому направлению, которое необходимо отразить.
Мы можем выделить три группы целевых аудиторий:
1. Технические пользователи — Test-manager. Для них приоритетно понимание хода тестирования, какие возникают проблемы, как они решаются, построение самого процесса тестирование, описание применяемых методов и технологий.
2. Product Manager, они же Менеджеры продукта. Их фокус сконцентрирован на сроках выполнения, выжимки из результатов тестирования без излишних технических подробностей и на общую статистику (цифровые и сравнительные метрики).
3. Бизнес-пользователи. Обычно это и есть те люди, которые принимают решения по завершению тестирования. Они же определяют качество проделанной работы. Для них, в первую очередь, важен конечный результат в максимально кратком и ясном формате (да\нет), наглядное представление информации (графики, диаграммы), экспертное мнение о возможности выпуска продукта в промышленную среду и т. п., без углубления в детали.

Вывод: Написать отчет, который устроит все группы, практически невозможно. Прежде чем писать отчет, обязательно определите целевую аудиторию. В зависимости от нее, содержание будет сильно отличаться своей структурой и содержать разные детали, необходимые конкретной группе.

Какова глубина временной выборки?

Отчёты могут делиться на два вида относительно времени:

1. (Недельный, дневной, месячный)/ промежуточный.
В общем, это практически тот же финальный отчет, но с измененными приоритетами фокуса и уменьшенной глубиной временной выборки. В нем обязательно должны содержаться две главных метрики:
— Оценка степени готовности продукта.
— Оценка проведённых работ по тестированию за время между отчетностями (прогресс).

Этот отчет должен показать какова динамика вашей работы.

Важно помнить, что прогресс – величина не постоянная, а динамическая, она определяется за счёт сравнения состояния проекта на прошлой неделе и настоящей. Соответственно прогресс – этот совокупность метрик, позволяющих понять в каком состоянии находится проект.
Они создаются для каждого проекта индивидуально, основываясь на целях, которые ставятся для успешного проведения тестирования. Метрики ставятся при создании ТК (тест-кейсов), прохождении ТК (провален\пройден), обнаружении дефектов (критичность). Они позволяют доступно и достаточно быстро составить общую сравнительную картину по проекту. Если вы, например, используете TestLink, то понимаете, что метрики позволяют делать быструю выборку по проблемам, составлять статистику проваленных ТК и т. п.
Данная информация полезна и необходима для Product Manager, её составляют и контролируют Test-manager, а также QE и SQE.
Есть еще один важный и часто используемые тип временного отчета – версионный (отчет по итерации).
Он схож с итоговым. В нём описываются те задачи, которые были выполнены командой тестирования для конкретной версии продукта.

2. Конечный /финальный.
В финальном отчете важно показать общий взгляд на проделанную работу (в контексте установленных метрик) и эволюцию продукта.
Так же, надо дать исчерпывающую информацию о статусе продукта в данный момент (количество оставшихся неисправленных ошибок, полностью ли протестирован продукт или требуется дополнительный цикл тестирования, оценка возможности выпуска продукта во «внешний мир» и т.д).

Вывод: Ведите статистику, используя метрики в течении всего проекта. Она поможет вам в нужный момент предоставить любую информацию заказчику и избавит от страха перед вопросами «А что конкретно вы сделали на четвертой неделе?» и «Что у нас со сроками?».

Какие приёмы представления информации и данных использовать в отчёте?

Когда технический специалист пишет для другого технического специалиста, вопрос о применении тех или иных приемов отражения информации возникает редко. Термины, формулы, профессиональный сленг – это привычно и понятно. Гораздо сложнее писать отчеты для людей, которые относительно далеки от специфики тестирования.
Для Бизнес-пользователей, зачастую, используют представление информации в виде графиков. Они наглядно показывают на сколько продукт готов к выпуску в промышленную среду, на сколько процентов проект выполнен.
Это может быть, к примеру, график пройденных ТК п о модулям. Он наглядно покажет, какой объем работы в каждом модуле уже проделан и поможет вычленить проблемы.

Так же, очень полезным может быть график отношения созданных тикетов (обнаруженных багов) и закрытых (исправленных багов). Не даром он является основным во многих таск-трекерах.
В случае продуктивной работы программистов над исправлением дефектов и написанием качественного кода кривая критических ошибок с выходом нового релиза стремиться к низу, при этом приоритет и важность ошибок тоже уменьшается.
Но, если разработчиками или тестировщиками уделяется мало внимания существующим дефектам, то кривая закрытых багов растет медленнее, чем не закрытых.
В идеальном случае кривая незакрытых багов (найденных, но не исправленных) должна сойтись с кривой исправленных. Другими словами, к финальному релизу необходимо, что бы все дефекты были устранены. Если это не так, то руководство может принять решение о продлении разработки и тестирования с целью устранения всех дефектов или выпустить продукт в «прод», беря на себя возможные риски.
В дополнение к графику необходимо оформлять сводную таблицу. График строится на основании этих данных.
Вот пример таблицы, на основании которой был построен график пройденных ТК по модулям:

Вывод: График для бизнес-пользователей — обязательная часть отчетности. Он информативен, доступен и понятен конечному пользователю, демонстрирует динамику активности на проекте или, в худшем случае — застой.
Так же, использование графиков в отчетах для любых пользователей и технических специалистов целесообразно тогда, когда надо быстро и наглядно сравнить цифры и показать динамику.

ЧТО НУЖНО УКАЗЫВАТЬ В ОТЧЕТЕ ВСЕГДА?

Может показаться, что отчеты разных типов сильно отличаются.

Тем не менее, в них есть схожие черты и данные, которые стоит указывать всегда.
Вот они:
1. Состав команды;
2. Сроки выполнения, за которые составляется отчет;
3. Описание процессов тестирования;
4. Изменения тестовой модели, дополнение ТК;
5. Процент пройденных ТК;
6. Критичные и блокирующие проблемы и принятые меры по их устранению;
7. Результаты регресса (плюс акцент на сохранившихся проблемах);
8. План на следующую итерацию\ неделю\ месяц;

Пункты 3, 4, 6 и 8 стоит писать с оглядкой на целевую аудиторию отчета.
Седьмой пункт стоит указывать тогда, когда проводилось «регресс-тестирование». Обычно этот пункт фигурирует в «версионных» отчетах.

Пункт 8 из итогового отчета исключается.

Заключение

Итак, мы поняли нашу целевую аудиторию, обозначили период, за который мы будем писать отчет, определили содержание и блоки. На самом деле — это практически все, что надо, чтобы сформировать понятный документ, который обязательно найдет отклик в головах тех, кому он адресован.
Пишите ваши отчеты детально, грамотно и с удовольствием, ведь хороший отчет – это как минимум треть работы и единственная ее часть, которая видна кому-то, кроме тестировщиков и программистов.

Источник статьи: http://habr.com/ru/company/performance_lab/blog/207512/

Как делать красивые и понятные клиентам отчеты

Валентина Евтюхина, специалист по digital-коммуникациям City Life и автор Телеграм-канала Digital Eva, написала для блога Нетологии колонку о том, как правильно оформить отчет, чтобы тот был без проблем понятен клиенту.

С регулярными отчетами для клиентов знакомы специалисты на фрилансе и в агентствах — если вы работаете над проектом клиента или занимаетесь маркетингом внутри компании, отчеты — неотъемлемая часть операционных дел.

Зачем нужны отчеты

Отчет формирует общую картину за период работы. Некоторые специалисты ограничиваются письмами с повесткой дня или итогами месяца, но этого недостаточно. Например, прошел месяц, вы занимались продвижением в социальных сетях или работой с сайтом, и вам кажется, что работы проделано много, и она выполнена хорошо. Но люди со стороны, например, клиенты или директор, видят это совсем иначе. Для них эффективность измеряется показателями, которые лежат на поверхности — клики, показы, переходы.

Данные, которые доступны вам, часто остаются недосягаемыми для остальных участников проекта.

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

Почему отчеты — это сложно

Составление показательных отчетов — сложный процесс, потому что нет единого сервиса для работы с аналитикой: для каждой задачи приходится выгружать данные из разных систем, будь то рекламный кабинет Яндекс.Директа, отчеты в Яндекс.Метрике или Google Analytics. При этом в каждой системе перед выгрузкой данных надо задействовать правильные фильтры, сделать скриншоты, проработать таблицы в Excel и адаптировать их таким образом, чтобы было клиенту с первого взгляда было понятно, где искать нужные показатели и на какие столбцы обращать особое внимание.

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

С другой стороны, современные технологии, например, BI, позволяют внедрять автоматизированные системы веб-аналитики в работу любого отдела или целого проекта. Проблема в том, что на их написание, тестирование и релиз уходит большое количество времени и человекоресурсов. Например, в этой статье можно почитать, как целая команда за 5 месяцев (!) создала BI-продукт для Netpeak. В его возможности входила аналитика исключительно контекстной рекламы, когда на деле клиенту чаще всего требуется отчетность по всем источникам и рекламным кампаниям, и контекстная реклама является лишь сотой долей от общего объема работ.

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

Как оформлять и отправлять отчет клиентам и руководству

Хуже неструктурированного отчета может быть только красивый отчет без пояснительных блоков.

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

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

Пример разбора метрик в отчете

Также не поленитесь составить сопроводительное письмо к отчету, в котором кратко изложите методы, инструменты, цели и результаты за период. Тогда клиент еще до детального знакомства с отчетом поймет, что все в порядке — команда работает и результаты есть.

За основу для сопроводительного письма можно взять выводы из отчета и самые важные комментарии к блокам. Но заменять отчет письмом все же не стоит, даже если ваши отчеты не читают, их все равно хранят: например, маркетолог может отчитываться перед руководством на основании ваших отчетов.

Пять полезных рекомендаций для создания отчетов

1. Используйте специальные программы для презентаций

Самая популярная программа — PowerPoint. Она позволяет создавать серии слайдов с текстовыми и визуальными блоками, добавлять логотип компании, использовать различные шрифты и цветовые решения.

Google Презентации — самый популярный из облачных сервисов, доступен на любом устройстве, прост и удобен в использовании. Есть возможность совместной работы над презентацией в онлайн-режиме; большой выбор шаблонов и фирменные шрифты.

Для пользователей iOS-устройств есть Keynote — приложение для создания презентаций в заранее выбранном шаблоне. Можно выбрать фон, нестандартное расположение объектов, использовать собственные шаблоны, сохранять презентации в формате PDF или pptx.

2. Работайте с шаблонами

Красивый, приятный глазу отчет можно создать без помощи дизайнера, просто выбрав подходящий шаблон для презентации. Например, на сайте slidescarnival.com есть бесплатные шаблоны по самым разным темам — коммерческие, технологические и креативные команды найдут для своих презентаций подходящий вариант. Эти шаблоны можно использовать как в Google Презентациях, так и в Power Point.

В Keynote есть масса встроенных шаблонов: для магазинов, дизайнеров, выставок, редакций, музыкантов и технологичных компаний.

3. Внимательно проверяйте тексты на ошибки

Готовя отчет для клиента, убедитесь, что не допустили ошибок не только в расчетах, но и в тексте. Грамотная письменная речь — показатель профессионализма и серьезного отношения к делу. Будет неприятно, если клиент заметит элементарные ошибки в словах: это покажет ваше халатное отношение к составлению отчета и работе в целом. В случае если нет возможности нанять корректора, пользуйтесь сервисами, которые могут его заменить.

Орфограммка — веб-сервис проверки правописания. Достаточно вставить фрагмент текста в специальное окно и нажать кнопку «Проверить», и все стилистические и грамматические ошибки подсветятся соответствующим цветом. Вам останется только переписать текст на основе рекомендаций сервиса.

Главред помогает сделать текст максимально информативным и понятным.

4. Используйте все возможности Excel

Если отчет требует добавления выгрузки в Excel, постарайтесь максимально снизить уровень ручной обработки данных в таблицах, доверив это формулам. Используйте функцию автоматического выделения цветом большого объема цифр, чтобы клиенту визуально было удобно ориентироваться в данных. Вот тут подробно описано, как создать диаграмму Ганта в Google Таблицах, которая позволит визуализировать количество затраченных ресурсов на проект или отдельный процесс в рамках проекта. А вот в этом видео подробно показано создание круговых диаграмм на основе данных из таблицы.

5. Собирайте данные с помощью сервисов

Маркетологи используют множество сервисов для анализа и прогнозирования, поэтому во время составления отчета им приходится собирать данные вручную из каждой рекламной системы и форматировать их под единый стиль презентации. Чтобы ускорить этот процесс, рекомендуем пользоваться сервисами, собирающими аналитику из разных систем — рекламных кабинетов в социальных сетях, Google Analytics и Яндекс.Метрики. Подключив системы к одному сайту, вы получаете единый отчет нажатием одной кнопки.

reportkey — сервис для маркетологов, smm-менеджеров и seo-специалистов, который собирает данные из рекламных кабинетов социальных сетей, счетчиков аналитики и сторонних систем в удобные отчеты. Доступна интеграция с Яндекс.Метрикой и Google Analytics, выгрузка данных из рекламных кабинетов ВКонтакте и Facebook, а также из Instagram (если реклама запущена через кабинет Facebook), SEOlib, Allpositions и Топвизора.

Improvado — сервис для сбора данных из пятидесяти различных аналитических платформ и социальных сетей, с визуализацией и возможностью адаптировать сервис под себя.

ReportGarden — сервис для составления отчетов с интеграцией самых разных платформ, включая почтовый сервис MailChimp, данные Google Analytics и выгрузки статистики из социальных сетей.

Google data studio — простой инструмент для работы со сквозной аналитикой, который позволяет решать простейшие задачи по анализу и визуализации данных.

Работает только с шестью источниками информации: AdWords API, Attribution 360, BigQuery, Google Analytics, Google Sheets, YouTube Analytics.

Помните, что основная задача отчета — не запутать клиента, а понятно донести суть работы, обозначить контрольные точки и предложить новые решения на основе данных.

Мнение автора и редакции может не совпадать. Хотите написать колонку для «Нетологии»? Читайте наши условия публикации.

Источник статьи: http://netology.ru/blog/krasivye-otchety