Доклад Андрея Кудинова на конференции Analyst Days-4, 17-18 апреля 2015 г., Минск www.analystdays.com

1. Ревью проектных документов
– борьба за качество
Андрей Кудинов
Компания «Неофлекс»
dragan2003@bk.ru

2. Определения
• Ревью – собирательное название
процесса, основное содержание которого
заключается в анализе текста документов
• Проверяется корректность,
непротиворечивость, полноту, ясность,
проверяемость и другие критерии
качества документа. Критерии качества
определяются заранее и известны всем
участникам
• Другое название ревью - статическое
тестирование
• Ревью выполняется до передачи
документа «на согласование» Заказчику

3. Определения
• Известные варианты
• 1981 IBM, M. Fagan, IBM – best practice
• SEI CMM отдельная KPA “Peer Review”
• Варианты ревью:
• Peer Review - ревью членами проектной
команды, постоянно включенными в проект:
аналитиками, архитекторами, тестировщиками.
• Контрольный проход на совещании –
проводится с участием членов продуктовой
команды или членов других
• Инспекция приглашенным специалистом
• Согласование – ревью на завершающей стадии
разработки документа, в котором участвуют
члены проектной команды

4. Зачем нужно и что дает хорошее ревью?
• Автору документа
• Менеджеру проекта
• Команде проекта
• Компании
• Заказчику
Автору:
1. Снижение re-work (переделок документа)
2. Уверенность в том, что нет явных недостатков
3. Защищенность в случае обнаружения ошибок
4. Опыт написания «правильных» документов
Менеджеру проекта:
1. Снижение re-work на фазе тестирования
2. Снижение риска непопадания в бюджет
3. Увеличение вероятности выполнения в срок
4. Увеличение вероятности получить премию
Команде проекта:
1. Понятные для всех документы, ускоренное
согласование
2. Повышение командного духа
3. Улучшение коммуникаций
Компании:
1. Увеличение вероятности успешного проекта
Заказчику:
1. Понятные документы
2. Ускоренное согласование
3. Повышение вероятности успешного проекта
Руководителю:
1. Контроль качества
2. Контроль за процессом
3. Обучение на ошибках

5. Кандидаты в ревьюеры
Артефакт
Аналитики
Потребители
требований
Партнеры по
взаимодействию
Авторы
требований

6. Что проверяем?
•Бизнес-цели
•Здравый смысл
•Изложение требований
•Оформление документа

7. √ Бизнес-цели
•Вселистейкхолдерывключены?
•Решены ли бизнес-цели
проекта?
•Совпадают ли цели проекта с
бизнес-целями?

8. √ Здравый смысл
•Понятенлископпроекта,имеетли
онсмысл?
•Есть описания as и to be?
•Бизнес-требования описаны в
терминах бизнеса?
•Не смешаны ли бизнес-
требования и функциональные
требования?

9. √ Изложение требований
•Ясность
•Непротиворечивость
•Отношение к скопу проекта
•Тестируемость
•Стиль

10. √ Оформление документа
•Схемыитаблицыпронумерованы
•Использован актуальный
шаблон документа
•Единые стили по всему
документу
•Исправлены орфографические
ошибки

11. Инструментарий ревьюера –
личный опыт
•Чек-лист(+баллы)
•Управление процессом
разработки артефактов в JIRA
•Заметки на полях
•Автогенерация списка открытых
вопросов

12. Чек-лист
№ Область проверки Формулировка проверки
(ожидаемый результат)
Тип несоответствия
Возможные значения:
1 - критичное
2 - серьезное
3 - незначительное
Дата проведения проверки
1
(заполняется значениями поля
"Проверка пройдена?")
1Наименование файла
с документом
В названии файла указан тип разрабатываемого
документа, номер BRD, бизнес-название
1
2Структура документа Структура документа должна соответствовать
шаблону ЧТЗ принятому на проекте иили
используемому в департаменте Неофлекса. Шаблон
ЧТЗ - <дать ссылку на шаблон ЧТЗ в SVN>
1
3Структура документа Структура документа содержит обязательные
разделы из шаблона проектного документа
1

13. Управление в JIRAАвтор
• Разработать и разместить документ в репозитории
• Перевести запрос в состояние «On Review», указать «Вид ревью» и имя
сотрудника в роли «Руководитель Ревьюеров»
• Заполнить поле «Ревьюер(ы)» именами коллег-участников Peer Review
(«пиров»)
• Назначить последовательно запрос на всех «пиров». Указать в
комментариях разделы документа для анализа.
DOC2.0
«Пиры»
Проанализировать, внести замечания в
документ, разместить документ в
репозитории («в стопочку»), списать
трудозатраты на задачу разработки
документа
Автор
Уточнить замечания, перевести запрос в
состояние «Reviewed»
Исправить замечания, создать/обновить
«Протокол ревью», разместить в
репозитории
Перевести запрос в состояние «Resolved»,

14. Заметки на полях

15. Список открытых вопросов
Текст с примечанием Автор
примечания
Раздел Примечание Дата
примечания
Статус Комментарий автора
документа
Критичность
Платежный документ С. Захаров 1.3. Платежный документ - юридически значимый документ
установленного формата, которым оформляются
банковские операции (платежи, переводы, взимание
комиссий и т.п.)
12.03.2014 Closed Исправлено Замечание
Массив проводок платежного
документа
С. Захаров 1.3. Массив проводок платежного документа - совокупность
бухгалтерских проводок, предназначенных для
бухгалтерского учета (отражения на балансе банка)
исполнения операции, регламентированной платежным
документом.
12.03.2014 Closed Исправлено Замечание

16. Проблемы ревью
•Сложно«продать»
•Низкое качество ревью
•Сложно контролировать
•Ложные ожидания

17. Решение проблем ревью
Как«продать»ревью
•Найдем сильного союзника
•Постоянный внутренний
пиар и обучение
•Проведем соревнование
Какобеспечить качестворевью
•Правильные ревьюеры
•Правильное время
•Чеклист
•Аудит ревью

18. Решение проблем ревью
Какконтролировать
•JIRA
•Отчеты
•Протоколы
Управлениеожиданиями
•Ошибки все равно останутся
•За документ отвечает автор

19. Полезные ссылки
Karl Wiegers Webinar «5 Steps to Better Requirements Peer
Reviews»
http://www.batimes.com/business-analyst-training/public-description-
lead.html?Event_ID=WID00093
Rebecca Burgess «Use and profit from peer reviews of
requirement documents»
http://www.batimes.com/articles/bad-ass-ba-peer-review.-part-1.html
http://www.batimes.com/articles/bad-ass-ba-peer-review.-part-2.html
http://www.batimes.com/articles/bad-ass-ba-peer-review.-part-3.html
http://www.batimes.com/articles/bad-ass-ba-peer-review.-part-4.html
Леонид Новиков «Rational Unified Process - как достичь 3-
го уровня CMM»
http://www.interface.ru/home.asp?artId=2312

20. Спасибо за внимание
Андрей Кудинов
Компания «Неофлекс»
dragan2003@bk.ru