anatol filin pragmatic documentation 0 5
TRANSCRIPT
![Page 1: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/1.jpg)
Прагматичный подход к документированию Веб-проектов
Анатолий ФилинГрамант
![Page 2: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/2.jpg)
План доклада• Откуда ноги растут – набитые шишки• Какая вообще бывает документация и зачем она
нужна• Какие бывают проекты и команды• Роли на проекте
![Page 3: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/3.jpg)
Откуда ноги растутНаучные библиотеки для российского суперкомпьютера Векторный Фортран, векторный ассемблер. Несколько человеко-лет
Трейдинговые системы. С, С++, Perl5. 3-10 человеко- лет
Система онлайновой рекламы. ColdFusion, Java. 50-100 человеко-лет
Заказные проекты. Java, PHP, Grails. 5–20 человеко-месяцев
![Page 4: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/4.jpg)
Стиль документации = команда + проект
![Page 5: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/5.jpg)
При чем здесь Веб?• Большая часть проектов – интерфейсные
(оболочечные)• Много проектов, которые копируют другие известные
проекты• Широкое использование API, других готовых
строительных блоков• Распределенные команды чаще, чем в традиционных
приложениях
![Page 6: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/6.jpg)
Существенные параметры• По какому процессу работаем• Внутренний проект или аутсоурсинг• Требуемая точность оценки• Размер проекта• Полнота команды (свои дизайнеры, аналитики и т.д.)
![Page 7: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/7.jpg)
Проект: глубина vs ширина
![Page 8: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/8.jpg)
Проект: size matters
![Page 9: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/9.jpg)
Роли на Веб-проекте
• Инвестор• Заказчик• Бизнес-аналитик• Системный аналитик• Менеджер проекта
• Разработчик• Проектировщик
интерфейсов• Тестировщик• Системный
администратор
![Page 10: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/10.jpg)
Команда
ИнвесторРазработчики
ЗаказчикPM
Дизайнер
![Page 11: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/11.jpg)
Куча документов• Бизнес-план: Рынок, Цели проекта, этапы, экономика• Концепция системы (Vision): 1-2 стр, с высоты птичьего полета• Набор фич (Features list): Что должна делать система по фичам• Бизнес-требования (Business requirements, BRD): Что? 5-20 страниц• Функциональные требования (Functional requirements, FRD): Как? 20-
100 страниц• Список рисков• Технические и архитектурные требования (Technical Architecture
Document, TAD)• Эскизы и макеты экранов• Требования к инфраструктуре (IAD)• User stories (Agile)
![Page 12: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/12.jpg)
Поток документовКонцепциясистемы Бизнес-
требования Требования к архитектуре
или Список фич
Функциональныетребования
Макеты экранов
Риски
Требования к инфраструктуре
Тест-планБизнес-план
![Page 13: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/13.jpg)
Уточнение стоимости
![Page 14: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/14.jpg)
Роли и документыИнвестор Бизнес-план Концепция системы Бизнес-требования
Заказчик (Business owner)
Концепция Бизнес-требования или набор фич Функциональные требования, Макеты экранов
Бизнес-аналитик Видение, Бизнес-требования
Системный аналитик Бизнес-требования Функциональные требования
Разработчик Функциональные требования технические требования
Тестировщик Функциональные требования Требования к тестированию
Проектировщик интерфейсов
Бизнес-требования Макеты экранов
Системный администратор
Функциональные требования Требования к инфраструктуре
![Page 15: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/15.jpg)
А где же аналитика?
![Page 16: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/16.jpg)
Очевидные правила• Если нужна грубая оценка, делаем BRD, если нужна точная
оценка – делаем FRD • Если проектировщик интерфейсов вне команды, нужно задание
для проектировщика, либо FRD• Если проект «интерфейсный» достаточно BRD и макетов
экранов• Если проект «глубокий» нужна аналитика и соответственно FRD
![Page 17: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/17.jpg)
Проект: корпоративный• Внутренний заказчик -> нужна грубая оценка по срокам• Монолитная команда• Небольшой проект: 3-5 человеко/месяцев
• Бизнес-требования – Экраны - Система
![Page 18: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/18.jpg)
Проект: старт-ап• Внутренний заказчик -> нужна грубая оценка по срокам• Монолитная команда• Небольшой проект: 3-5 человеко/месяцев
• Бизнес-требования – Экраны - Система
![Page 19: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/19.jpg)
А что если Agile?
stories
ите
рац
ии
Текущийсрез
системы
![Page 20: Anatol Filin Pragmatic Documentation 0 5](https://reader035.vdocument.in/reader035/viewer/2022081508/555e1688d8b42a99188b54f5/html5/thumbnails/20.jpg)
А теперь – мастер-класс
Берем проект, обсуждаем и решаем, какая будет нужна документация