October 30th, 2008
Категории документации и типовые роли её авторов
Грубо можно выделить 3 категории документации, окружающих обычную IT-систему/продукт:
- Предпроектная — создаётся на этапах, предшествующих детальному определению внешних свойств и внутреннего устройства системы.
- Проектная — содержит основной пакет проектных решений
- Эксплуатационная — используется для развёртывания, использования и модернизации системы
Какие документы можно отнести к этим категориям?
Предпроектная документация
- Постановка проблемы
- Отчёт об обследовании деятельности
- Концепция системы
- Бизнес-план
- BRD / MRD / PRD / FSD
- Пользовательские требования
- Техническое задание
- Технико-экономическое обоснование
Проектная документация
- Функциональная спецификация
- Эскизный проект
- Документ архитектуры системы
- Технический проект
- Техническая спецификация
Эксплуатационная документация
- Руководство администратора
- Руководство пользователя
- Руководство разработчика
Кто должен выступать основным автором этих документов при инженерном (а не халтурном) подходе к организации ведения проектов?
- Предпроект — маркетологи, бизнес-аналитики, процессные технологи, менеджеры продукта, системные аналитики.
- Проект — системные аналитики, системные архитекторы, проектировщики подсистем, инженеры-конструкторы.
- Эксплуатация — инженеры-разработчики, технические писатели, инженеры-администраторы, процессные технологи.
Почему это важно?
Это понимание важно потому, что в настоящее время у многих участников малых и средних IT-проектов, зачастую попавших в индустрию «случайно», что особенно характерно для веб-проектов, наблюдается устойчивый стереотип, что документацию перечисленных категорий и видов документов должны создавать технические писатели, прежде всего, и только.
На самом деле это не так, технические писатели могут быть отличными ОФОРМИТЕЛЯМИ документации и могут достаточно неплохо почти самостоятельно справляться с 3-й — эксплуатационной категорией документации, но для того, чтобы создавать документы 1-й и 2-й категорий (а документы сами по себе не являются самоцелью, а являются лишь форматом коммуникации результатов работ), нужно обладать соответствующей квалификацией, согласно перечисленным выше ролям.
Что делать?
Если ваши маркетологи, аналитики, инженеры не справляются с созданием предпроектной и проектной документации (в объёме, когда затраты на создание документа меньше рисков и ущерба от работы от него) — значит им не хватает квалификации.
Если страдает оформление — наймите техписа.
Если страдает содержание — организуйте обучение или наймите профессионалов.