О технической документации (часть 3). Состав документации
Это цикл статей, посвященный разработке технической документации:
Введение >> Часть 1 >> Часть 2 >> Часть 3 >> Часть 4 >> Часть 5
Какие существуют виды технических документов?
Отечественные и зарубежные стандарты предусматривают возможность разработки более сотни видов различных документов, а также определяют требования к их содержанию и оформлению. Кроме того, существует еще множество иных видов технических документов, требования к которым не стандартизованы, но которые также достаточно популярны. Неподготовленный читатель может потратить изрядное количество времени, перебирая все доступные виды документации и пытаясь разобраться во всех тонкостях.
Как же определиться с составом комплекта документации?
В данном случае возможны следующие типовые сценарии:
- Состав комплекта документации известен и зафиксирован (отражен в договоре, договор подписан/не подписан). Это самый выгодный сценарий – в этом случае вопросов не возникает в принципе (не забывайте только фиксировать требования к содержанию и оформлению отдельных видов технических документов).
- Состав комплекта документации под вопросом (отражен/не отражен в договоре, договор не подписан). Это самый распространенный сценарий – в этом случае достаточно просто совместно сформировать и утвердить перечень документации для разработки, после чего добавить его в договор на подпись.
- Состав комплекта документации учтен (не отражен в договоре, договор подписан). Это самый опасный сценарий – в этом случае вариантов только два: либо сформировать комплект самостоятельно (или с помощью экспертов) и аргументированно его отстаивать перед заказчиком, либо «прогибаться» под заказчика и разрабатывать те виды документации, которые он просит. Однако в первом случае без лишних споров уже не обойтись, во втором – результат непредсказуем (можно по кругу разрабатывать новые и модифицировать существующие материалы).
Как прописать перечень документации?
Однако если сценарий все же благоприятный, при составлении перечня документации постарайтесь придерживаться следующих правил:
- Для каждой стадии жизненного цикла должны быть разработаны свои виды технических документов. Ситуация, когда для какой-либо стадии документы отсутствуют вообще, неприемлема.
- Состав дополнительных технических документов определяется перечнем заинтересованных лиц. Если не ясно, кому и для чего требуется разработать документ – такой документ, скорее всего, не нужен.
Совет №3 Перед выбором состава документации, всегда обращайте внимание на то, для какого именно этапа вам необходимо разработать текущий пакет документации. Или можете обратиться к нам и описать свою ситуацию – мы подскажем.