Recommended
More Related Content
What's hot
What's hot (8)
Similar to Приемы работы с документацией
Similar to Приемы работы с документацией (20)
Приемы работы с документацией
- 1. ПРИЕМЫ РАБОТЫ С ДОКУМЕНТАЦИЕЙ ВЗГЛЯД ГЛАЗАМИ РАЗРАБОТЧИКА АРТЕМ ВОРОНЦОВ, главный разработчик 22 отдел СПБ ГУП «СПБ ИАЦ», 2017
- 2. НАЧАЛО
- 3. НОВАЯ РЕАЛЬНОСТЬ Полный комплект документации по ГОСТЭкранная форма
- 4. AGILE МАНИФЕСТ Люди и взаимодействие важнее процессов и инструментов Работающий продукт важнее исчерпывающей документации Сотрудничество с заказчиком важнее согласования условий контракта Готовность к изменениям важнее следования первоначальному плану
- 5. ДЕКОМПОЗИЦИЯ Пояснительная записка на систему Пояснительная записка на подсистему Пояснительная записка на комплекс задач
- 6. ШАБЛОН ДОКУМЕНТАЦИИ Стили документа Структура документа Примеры описания
- 8. ОТТРЕБОВАНИЙТЗ ДО ЗАДАЧИ ТребованияТЗ Задачи в Jira
- 9. ОТ ДОКУМЕНТА ДО ЗАДАЧИ Отчетный документ ГК Задачи в Jira
- 10. СТАДИИ ЗАДАЧИ Open Dev Review Test UX Resolved
- 12. РЕВЬЮ.ЧЕК ЛИСТ
- 13. РЕТРОСПЕКТИВА Участники команды проводят ревью одной документации Все полученные замечания классифицируются По всем замечаниям прорабатываются решения Решения согласуются командой Полученные результаты фиксируются
- 14. ОПИСАНИЕ ЗАДАЧИ
- 15. АВТОМАТИЗАЦИЯ ПОДГОТОВКИ ДОКУМЕНТОВ Описание организации информационной базы
- 16. АВТОМАТИЧЕСКАЯ СБОРКА ПРОЕКТА Сборка приложения • Из актуальных исходных кодов Генерация эксплуатационной документации • Руководство пользователя • История изменений Публикация приложения
- 17. РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ Руководство пользователя Встроенное руководство пользователя Контекстная справка
Editor's Notes
- Наконец мы дошли до самой горячо обсуждаемой темы в области работы с ГК – отчетной документации. Действительно сейчас дела доходят до того, что заказчику сдаются десятки килограммов бумаги, перевозимые на газелях. Однако, практической пользы от этого, зачастую не так много. В тоже время Agile манифест гласит, что "работающий продукт важнее исчерпывающей документации», а ГОСТ сам по себе не требует создавать все виды документов, он лишь их описывает их многообразие для любого вида систем. Поэтому в ТЗ к ГК нужно предъявлять требования к созданию только той документации, которая необходима для создаваемого вида автоматизируемой системы (АС) и ПО. В ходе ее разработки следует избегать дублирования информации в нескольких документах, используя перекрестные ссылки между ними. Для удобства восприятия и сокращения затрат на последующее внесение изменений можно декомпозировать документы на логические части. Ну и самое главное это использовать средства автоматизации как для генерации документов, так и в качестве основы для их содержания. То есть если в проекте используются средства автоматизированного развертывания, настройки конфигурации, тестирования, то такая рабочая документация должна сводится к инструкция по их запуску.
- Наконец мы дошли до самой горячо обсуждаемой темы в области работы с ГК – отчетной документации. Действительно сейчас дела доходят до того, что заказчику сдаются десятки килограммов бумаги, перевозимые на газелях. Однако, практической пользы от этого, зачастую не так много. В тоже время Agile манифест гласит, что "работающий продукт важнее исчерпывающей документации», а ГОСТ сам по себе не требует создавать все виды документов, он лишь их описывает их многообразие для любого вида систем. Поэтому в ТЗ к ГК нужно предъявлять требования к созданию только той документации, которая необходима для создаваемого вида автоматизируемой системы (АС) и ПО. В ходе ее разработки следует избегать дублирования информации в нескольких документах, используя перекрестные ссылки между ними. Для удобства восприятия и сокращения затрат на последующее внесение изменений можно декомпозировать документы на логические части. Ну и самое главное это использовать средства автоматизации как для генерации документов, так и в качестве основы для их содержания. То есть если в проекте используются средства автоматизированного развертывания, настройки конфигурации, тестирования, то такая рабочая документация должна сводится к инструкция по их запуску.