SlideShare a Scribd company logo
1 of 39
Download to read offline
ПРИЕМЫ РАБОТЫ С ДОКУМЕНТАЦИЕЙ
ВЗГЛЯД ГЛАЗАМИ РАЗРАБОТЧИКА
АРТЕМ ВОРОНЦОВ, главный разработчик
СПБ ГУП «СПБ ИАЦ»,
2017
ОБО МНЕ
Аналитик (?)
Разработчик
Программист-тестировщик
Релиз инженерАртем Воронцов
НАЧАЛО
НОВАЯ РЕАЛЬНОСТЬ
Полный комплект документации по ГОСТЭкранная форма
AGILE МАНИФЕСТ
Люди и взаимодействие важнее процессов и
инструментов
Работающий продукт важнее исчерпывающей
документации
Сотрудничество с заказчиком важнее согласования условий
контракта
Готовность к изменениям важнее следования
первоначальному плану
ОСНОВНЫЕ СЛОЖНОСТИ
 Большое количество отчетной
документации
 Низкая (практическая) польза
(для команды)
 (bonus) подготовка возложена
на команду разработчиков исчерпывающая
документация
работающий
продукт
КОМАНДА
ДОКУМЕНТАЦИЯ
Цели
 Минимизировать объем
создаваемых документов
 Максимизировать пользу
создаваемых документов
 Обеспечить актуальность
документации
Для чего создается*
 Для разработки ПО
 Для использования ПО
 Для заказчика
DRY (DON’T REPEATYOURSELF)
Каждая часть знания должна иметь
единственное, непротиворечивое и
авторитетное представление в
рамках системы
ДЕКОМПОЗИЦИЯ
Пояснительная записка
на систему
Пояснительная записка
на подсистему
Пояснительная записка
на комплекс задач ГОСТ 34
ПЕРЕКРЕСТНЫЕ ССЫЛКИ
Пояснительная записка на систему
Схема функциональной структуры
ГОСТ 34
ISO 9001 СИСТЕМЫ МЕНЕДЖМЕНТА КАЧЕСТВА
ISO 9001 СИСТЕМЫ МЕНЕДЖМЕНТА КАЧЕСТВА
СИСТЕМА КОНТРОЛЯ ВЕРСИЙ
ОТТРЕБОВАНИЙТЗ ДО ЗАДАЧИ
Требования ТЗ Задачи в Jira
УЧЕТ ДОКУМЕНТАЦИИ
Отчетный документ ГК Задачи в Jira
ОПИСАНИЕ ЗАДАЧИ НА ДОКУМЕНТАЦИЮ
КАНБАН-ДОСКА
Open Dev Review Test Resolved
3 AMIGO MEETINGS*
 Участники команды проводят ревью одной документации
 Все полученные замечания классифицируются
 По всем замечаниям прорабатываются решения
 Решения согласуются командой
 Полученные результаты фиксируются
ШАБЛОН ДОКУМЕНТАЦИИ
Стили документа
Структура документа
Примеры описания
СОГЛАШЕНИЕ ПО НАПИСАНИЮ
КАНБАН-ДОСКА
Open Dev Review Test Resolved
РЕВЬЮ
Кто проводит
 Аналитик
 Тестировщик
 Технический писатель
 Разработчик
 Структуру
 Оформление
 Стиль
 Полноту
 Содержание
Что проверяют
РЕВЬЮ.ЧЕК ЛИСТ
РЕТРОСПЕКТИВА*
 Участники команды проводят ревью одной документации
 Все полученные замечания классифицируются
 По всем замечаниям прорабатываются решения
 Решения согласуются командой
 Полученные результаты фиксируются
ОПИСАНИЕ ЗАДАЧИ НА РАЗРАБОТКУ
ЖЦ ЗАДАЧИ НА РАЗРАБОТКУ
Разработка Контроль
Тестирование,
исправление
ошибок
Актуализация
рабочей
документации
Требуется доработка
Начало Конец
Не требуется актуализация документации
КАНБАН-ДОСКА + UX
Open Dev Review Test ResolvedUX
ПОСЛЕДНИЕ ИЗМЕНЕНИЯ
РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ
Руководство
пользователя
Встроенное руководство пользователя
Контекстная справка
CI (АВТОМАТИЧЕСКАЯ СБОРКА ПРОЕКТА)
Сборка приложения
• Из актуальных исходных кодов
Публикация приложения
Сборка приложения
• Из актуальных исходных кодов
Генерация документации
• Руководство пользователя
• Последние изменения
Публикация приложения
ОПИСАНИЕ ОРГАНИЗАЦИИ ИНФОРМАЦИОННОЙ БАЗЫ
Описание организации информационной базы
РУКОВОДСТВО АДМИНИСТРАТОРА
 Передача заказчику
 исходных кодов ПО,
 конфигурационных файлов,
 скриптов запуска.
 Описание в документации
запуска скриптов,
конфигурирующих среду.
система управления
конфигурациями
ВЗГЛЯД В БУДУЩЕЕ
 Сокращение количества избыточности
отчетных документов
 Исключение «устаревших» документов
 Переход к электронным версиям
документов
 Внедрение ЭЦП в документооборот
БУДУЩЕЕ УЖЕ РЯДОМ ;-)
http://zakupki.gov.ru/epz/contract/contractCard/document-info.html?reestrNumber=1771047437516000071
СОКРАЩЕНИЕ ИЗБЫТОЧНОСТИ
СОКРАЩЕНИЕ ИЗБЫТОЧНОСТИ
ЭЛЕКТРОННЫЙ ДОКУМЕНТООБОРОТ
Артем Воронцов
artemvorontsov@gmail.com
Спасибо за внимание!
http://amigosteam.ru/
https://www.youtube.com/user/AmigosTeam2009

More Related Content

What's hot

Scrum глазами тестировщика или как создать стратегию для любой задачи
Scrum глазами тестировщика или как создать стратегию для любой задачиScrum глазами тестировщика или как создать стратегию для любой задачи
Scrum глазами тестировщика или как создать стратегию для любой задачиIT61
 
Обеспечение качества: Практические советы
Обеспечение качества: Практические советыОбеспечение качества: Практические советы
Обеспечение качества: Практические советыSQALab
 
На пути к совершенному инжинирингу
На пути к совершенному инжинирингуНа пути к совершенному инжинирингу
На пути к совершенному инжинирингуVitebsk DSC
 
Шаблоны проектирования нагрузочных скриптов
Шаблоны проектирования нагрузочных скриптовШаблоны проектирования нагрузочных скриптов
Шаблоны проектирования нагрузочных скриптовSQALab
 
Что ждет тестировщиков при организации процесса тестирования Enterprise-проду...
Что ждет тестировщиков при организации процесса тестирования Enterprise-проду...Что ждет тестировщиков при организации процесса тестирования Enterprise-проду...
Что ждет тестировщиков при организации процесса тестирования Enterprise-проду...SQALab
 
Test Automation as a way of Natural Evolution of a Project
Test Automation as a way of Natural Evolution of a ProjectTest Automation as a way of Natural Evolution of a Project
Test Automation as a way of Natural Evolution of a ProjectKateryna Nesmyelova
 
Discovery Kanban для управления беклогом Scrum-команды
Discovery Kanban для управления беклогом Scrum-командыDiscovery Kanban для управления беклогом Scrum-команды
Discovery Kanban для управления беклогом Scrum-командыCEE-SEC(R)
 
Crystal Agile, или как мы приспособили процесс разработки для обеспечения мак...
Crystal Agile, или как мы приспособили процесс разработки для обеспечения мак...Crystal Agile, или как мы приспособили процесс разработки для обеспечения мак...
Crystal Agile, или как мы приспособили процесс разработки для обеспечения мак...SQALab
 
Переписать нельзя рефакторить
Переписать нельзя рефакторитьПереписать нельзя рефакторить
Переписать нельзя рефакторитьCEE-SEC(R)
 
Процесс разработки Agile & Java
Процесс разработки Agile & JavaПроцесс разработки Agile & Java
Процесс разработки Agile & Javadevclub
 
Советы бывалого тестировщика менеджеру проектов
Советы бывалого тестировщика менеджеру проектовСоветы бывалого тестировщика менеджеру проектов
Советы бывалого тестировщика менеджеру проектовSQALab
 
андрей дмитриев взгляд со стороны разработчика
андрей дмитриев взгляд со стороны разработчикаандрей дмитриев взгляд со стороны разработчика
андрей дмитриев взгляд со стороны разработчикаAlexei Lupan
 
Невыносимая переносимость кроссплатформенных приложений на примере десктопных...
Невыносимая переносимость кроссплатформенных приложений на примере десктопных...Невыносимая переносимость кроссплатформенных приложений на примере десктопных...
Невыносимая переносимость кроссплатформенных приложений на примере десктопных...SQALab
 
WP как экспериментальная платформа
WP как экспериментальная платформаWP как экспериментальная платформа
WP как экспериментальная платформаSQALab
 
евгения фирсова нерелизное тестирование
евгения фирсова   нерелизное тестированиеевгения фирсова   нерелизное тестирование
евгения фирсова нерелизное тестированиеAlexei Lupan
 
тестирование программного обеспечения
тестирование программного обеспечениятестирование программного обеспечения
тестирование программного обеспеченияNatalia Zhelnova
 
Создание стратегии тестирования на основе анализа ТЗ по ГОСТ 19/34
Создание стратегии тестирования на основе анализа ТЗ по ГОСТ 19/34Создание стратегии тестирования на основе анализа ТЗ по ГОСТ 19/34
Создание стратегии тестирования на основе анализа ТЗ по ГОСТ 19/34Alexandra Varfolomeeva
 
Опыт автоматизации интеграционного тестирования и внедрения DevOps в банковск...
Опыт автоматизации интеграционного тестирования и внедрения DevOps в банковск...Опыт автоматизации интеграционного тестирования и внедрения DevOps в банковск...
Опыт автоматизации интеграционного тестирования и внедрения DevOps в банковск...COMAQA.BY
 

What's hot (20)

Scrum глазами тестировщика или как создать стратегию для любой задачи
Scrum глазами тестировщика или как создать стратегию для любой задачиScrum глазами тестировщика или как создать стратегию для любой задачи
Scrum глазами тестировщика или как создать стратегию для любой задачи
 
Обеспечение качества: Практические советы
Обеспечение качества: Практические советыОбеспечение качества: Практические советы
Обеспечение качества: Практические советы
 
На пути к совершенному инжинирингу
На пути к совершенному инжинирингуНа пути к совершенному инжинирингу
На пути к совершенному инжинирингу
 
Шаблоны проектирования нагрузочных скриптов
Шаблоны проектирования нагрузочных скриптовШаблоны проектирования нагрузочных скриптов
Шаблоны проектирования нагрузочных скриптов
 
Что ждет тестировщиков при организации процесса тестирования Enterprise-проду...
Что ждет тестировщиков при организации процесса тестирования Enterprise-проду...Что ждет тестировщиков при организации процесса тестирования Enterprise-проду...
Что ждет тестировщиков при организации процесса тестирования Enterprise-проду...
 
Test Automation as a way of Natural Evolution of a Project
Test Automation as a way of Natural Evolution of a ProjectTest Automation as a way of Natural Evolution of a Project
Test Automation as a way of Natural Evolution of a Project
 
Discovery Kanban для управления беклогом Scrum-команды
Discovery Kanban для управления беклогом Scrum-командыDiscovery Kanban для управления беклогом Scrum-команды
Discovery Kanban для управления беклогом Scrum-команды
 
Crystal Agile, или как мы приспособили процесс разработки для обеспечения мак...
Crystal Agile, или как мы приспособили процесс разработки для обеспечения мак...Crystal Agile, или как мы приспособили процесс разработки для обеспечения мак...
Crystal Agile, или как мы приспособили процесс разработки для обеспечения мак...
 
Переписать нельзя рефакторить
Переписать нельзя рефакторитьПереписать нельзя рефакторить
Переписать нельзя рефакторить
 
Процесс разработки Agile & Java
Процесс разработки Agile & JavaПроцесс разработки Agile & Java
Процесс разработки Agile & Java
 
Советы бывалого тестировщика менеджеру проектов
Советы бывалого тестировщика менеджеру проектовСоветы бывалого тестировщика менеджеру проектов
Советы бывалого тестировщика менеджеру проектов
 
андрей дмитриев взгляд со стороны разработчика
андрей дмитриев взгляд со стороны разработчикаандрей дмитриев взгляд со стороны разработчика
андрей дмитриев взгляд со стороны разработчика
 
Невыносимая переносимость кроссплатформенных приложений на примере десктопных...
Невыносимая переносимость кроссплатформенных приложений на примере десктопных...Невыносимая переносимость кроссплатформенных приложений на примере десктопных...
Невыносимая переносимость кроссплатформенных приложений на примере десктопных...
 
WP как экспериментальная платформа
WP как экспериментальная платформаWP как экспериментальная платформа
WP как экспериментальная платформа
 
евгения фирсова нерелизное тестирование
евгения фирсова   нерелизное тестированиеевгения фирсова   нерелизное тестирование
евгения фирсова нерелизное тестирование
 
Java one presentation
Java one presentationJava one presentation
Java one presentation
 
Oбзор и архитектура Team System 2010
Oбзор и архитектура Team System 2010Oбзор и архитектура Team System 2010
Oбзор и архитектура Team System 2010
 
тестирование программного обеспечения
тестирование программного обеспечениятестирование программного обеспечения
тестирование программного обеспечения
 
Создание стратегии тестирования на основе анализа ТЗ по ГОСТ 19/34
Создание стратегии тестирования на основе анализа ТЗ по ГОСТ 19/34Создание стратегии тестирования на основе анализа ТЗ по ГОСТ 19/34
Создание стратегии тестирования на основе анализа ТЗ по ГОСТ 19/34
 
Опыт автоматизации интеграционного тестирования и внедрения DevOps в банковск...
Опыт автоматизации интеграционного тестирования и внедрения DevOps в банковск...Опыт автоматизации интеграционного тестирования и внедрения DevOps в банковск...
Опыт автоматизации интеграционного тестирования и внедрения DevOps в банковск...
 

Similar to Артем Воронцов. Приемы работы с документацией глазами разработчика

Microsoft Team System 2010 для управления ЖЦ разработки и сопровождения ПО
Microsoft Team System 2010 для управления ЖЦ разработки и сопровождения ПОMicrosoft Team System 2010 для управления ЖЦ разработки и сопровождения ПО
Microsoft Team System 2010 для управления ЖЦ разработки и сопровождения ПОАлександр Шамрай
 
Приемы работы с документацией
Приемы работы с документациейПриемы работы с документацией
Приемы работы с документациейamigosteam
 
20160323 Пример бизнес-приложения контроля качества в розничной торговле
20160323 Пример бизнес-приложения контроля качества в розничной торговле20160323 Пример бизнес-приложения контроля качества в розничной торговле
20160323 Пример бизнес-приложения контроля качества в розничной торговлеAndrew Sovtsov
 
Внедрение CASE-технологий
Внедрение CASE-технологийВнедрение CASE-технологий
Внедрение CASE-технологийОтшельник
 
Rational Unified Processes Overview
Rational Unified Processes OverviewRational Unified Processes Overview
Rational Unified Processes OverviewVladimir Ivanov
 
метод организации репозитория исходного кода
метод организации репозитория исходного кодаметод организации репозитория исходного кода
метод организации репозитория исходного кодаSergii Shmarkatiuk
 
Сделать безопасно и сертифицировано — ЗАО «ПМ» на DevCon 2015
Сделать безопасно и сертифицировано — ЗАО «ПМ» на DevCon 2015Сделать безопасно и сертифицировано — ЗАО «ПМ» на DevCon 2015
Сделать безопасно и сертифицировано — ЗАО «ПМ» на DevCon 2015Maxim Avdyunin
 
Проект внедрения КИС
Проект внедрения КИСПроект внедрения КИС
Проект внедрения КИСSergey Timofeev
 
Разработка по с использованием Tfs 2012
Разработка по с использованием Tfs 2012Разработка по с использованием Tfs 2012
Разработка по с использованием Tfs 2012Александр Шамрай
 
CodeFest 2010. Уразов А. — Quality-Oriented Programming (Программирование, ор...
CodeFest 2010. Уразов А. — Quality-Oriented Programming (Программирование, ор...CodeFest 2010. Уразов А. — Quality-Oriented Programming (Программирование, ор...
CodeFest 2010. Уразов А. — Quality-Oriented Programming (Программирование, ор...CodeFest
 
Проектирование программных систем. Занятие 1
Проектирование программных систем. Занятие 1Проектирование программных систем. Занятие 1
Проектирование программных систем. Занятие 1Dima Dzuba
 
Широкое внедрение Agile Unified Process
Широкое внедрение Agile Unified ProcessШирокое внедрение Agile Unified Process
Широкое внедрение Agile Unified ProcessAgile Base Camp
 
Денис Бесков -- Послание аналитиков тестировщикам
Денис Бесков -- Послание аналитиков тестировщикамДенис Бесков -- Послание аналитиков тестировщикам
Денис Бесков -- Послание аналитиков тестировщикамsqadays8
 
Слайдкаст. Stratoplan Kharkov. Методологический паззл.
Слайдкаст. Stratoplan Kharkov. Методологический паззл.Слайдкаст. Stratoplan Kharkov. Методологический паззл.
Слайдкаст. Stratoplan Kharkov. Методологический паззл.Sergiy Povolyashko
 
Проектная команда: состав, роли, коммуникации
Проектная команда: состав, роли, коммуникацииПроектная команда: состав, роли, коммуникации
Проектная команда: состав, роли, коммуникацииDaria Veldina
 
Jubula – TDD UI QA Automation Tool
Jubula – TDD UI QA Automation ToolJubula – TDD UI QA Automation Tool
Jubula – TDD UI QA Automation ToolCOMAQA.BY
 

Similar to Артем Воронцов. Приемы работы с документацией глазами разработчика (20)

Microsoft Team System 2010 для управления ЖЦ разработки и сопровождения ПО
Microsoft Team System 2010 для управления ЖЦ разработки и сопровождения ПОMicrosoft Team System 2010 для управления ЖЦ разработки и сопровождения ПО
Microsoft Team System 2010 для управления ЖЦ разработки и сопровождения ПО
 
Приемы работы с документацией
Приемы работы с документациейПриемы работы с документацией
Приемы работы с документацией
 
Test design print
Test design printTest design print
Test design print
 
Quality assurance
Quality assuranceQuality assurance
Quality assurance
 
20160323 Пример бизнес-приложения контроля качества в розничной торговле
20160323 Пример бизнес-приложения контроля качества в розничной торговле20160323 Пример бизнес-приложения контроля качества в розничной торговле
20160323 Пример бизнес-приложения контроля качества в розничной торговле
 
Внедрение CASE-технологий
Внедрение CASE-технологийВнедрение CASE-технологий
Внедрение CASE-технологий
 
29.jan.2009 (www.cmcons.com)
29.jan.2009 (www.cmcons.com)29.jan.2009 (www.cmcons.com)
29.jan.2009 (www.cmcons.com)
 
Rational Unified Processes Overview
Rational Unified Processes OverviewRational Unified Processes Overview
Rational Unified Processes Overview
 
метод организации репозитория исходного кода
метод организации репозитория исходного кодаметод организации репозитория исходного кода
метод организации репозитория исходного кода
 
Сделать безопасно и сертифицировано — ЗАО «ПМ» на DevCon 2015
Сделать безопасно и сертифицировано — ЗАО «ПМ» на DevCon 2015Сделать безопасно и сертифицировано — ЗАО «ПМ» на DevCon 2015
Сделать безопасно и сертифицировано — ЗАО «ПМ» на DevCon 2015
 
Проект внедрения КИС
Проект внедрения КИСПроект внедрения КИС
Проект внедрения КИС
 
Разработка по с использованием Tfs 2012
Разработка по с использованием Tfs 2012Разработка по с использованием Tfs 2012
Разработка по с использованием Tfs 2012
 
CodeFest 2010. Уразов А. — Quality-Oriented Programming (Программирование, ор...
CodeFest 2010. Уразов А. — Quality-Oriented Programming (Программирование, ор...CodeFest 2010. Уразов А. — Quality-Oriented Programming (Программирование, ор...
CodeFest 2010. Уразов А. — Quality-Oriented Programming (Программирование, ор...
 
Training Labs (www.cmcons.com)
Training Labs (www.cmcons.com)Training Labs (www.cmcons.com)
Training Labs (www.cmcons.com)
 
Проектирование программных систем. Занятие 1
Проектирование программных систем. Занятие 1Проектирование программных систем. Занятие 1
Проектирование программных систем. Занятие 1
 
Широкое внедрение Agile Unified Process
Широкое внедрение Agile Unified ProcessШирокое внедрение Agile Unified Process
Широкое внедрение Agile Unified Process
 
Денис Бесков -- Послание аналитиков тестировщикам
Денис Бесков -- Послание аналитиков тестировщикамДенис Бесков -- Послание аналитиков тестировщикам
Денис Бесков -- Послание аналитиков тестировщикам
 
Слайдкаст. Stratoplan Kharkov. Методологический паззл.
Слайдкаст. Stratoplan Kharkov. Методологический паззл.Слайдкаст. Stratoplan Kharkov. Методологический паззл.
Слайдкаст. Stratoplan Kharkov. Методологический паззл.
 
Проектная команда: состав, роли, коммуникации
Проектная команда: состав, роли, коммуникацииПроектная команда: состав, роли, коммуникации
Проектная команда: состав, роли, коммуникации
 
Jubula – TDD UI QA Automation Tool
Jubula – TDD UI QA Automation ToolJubula – TDD UI QA Automation Tool
Jubula – TDD UI QA Automation Tool
 

Артем Воронцов. Приемы работы с документацией глазами разработчика