Команда > Авторские публикации > 2013 год > Экспертиза технической документации

Экспертиза технической документации

Техническая документация служит неотъемлемой составляющей процесса разработки любой системы и требует соответствующего содержания и оформления.

К документации, которая разрабатывается в рамках проведения государственных конкурсов и аукционов на закупку товаров, работ и услуг, предъявляются четкие требования к содержанию и оформлению, которые должны строго соответствовать государственному стандарту (ГОСТ) и требованиям, предъявляемым со стороны организаторов процедур государственного заказа.

К технической документации, которая разрабатывается для коммерческих структур, предъявляется набор корпоративных требований со стороны Заказчика.

При большом количестве закупочных процедур Заказчик сталкивается с проблемой дефицита ресурсов для проведения экспертизы результатов работ, в т. ч. отчетной документации, и вынужден прибегать к услугам внешних экспертов.

Экспертиза технической документации заключается в анализе соответствия разработанной технической документации предъявляемым требованиям, а также полноте, логичности и однозначности представленного материала, и выполняется в несколько этапов:

  1. Проверка комплектности переданных отчетных материалов, обозначенной в требованиях государственного контракта / договора.
  2. Проверка на соответствие структуры и содержания документа предъявляемым требованиям руководящих документов (Корпоративные стандарты / Государственные стандарты / Международные стандарты).
  3. Проверка на соответствие документа требованиям оформления (Руководства по корпоративному стилю (Brand book) / ГОСТ / Типографические нормы и правила).
  4. Проверка на соответствие текста документа грамматике русского (или иностранного) языка, при необходимости содействие в исправлении мелких орфографических и пунктуационных ошибок.

На каждом из этих шагов в тексте документа выносятся примечания с комментариями. Каждый комментарий должен быть понятным и содержать ссылку, на основании чего он дается. По итогам произведенных проверок формируется экспертное заключение с указанием критичности тех или иных замечаний и выводами.

Статистика проведенных экспертиз неумолима. «Идеальные» документы встречаются нечасто, что ожидаемо. Ведь ключевыми результатами проектов являются, как правило, информационные системы, поставляемое оборудование, ИТ-услуги. Документация рассматривается исполнителями как дополнительный балласт, которому придается мало значения.

Типовыми ошибками являются:

  • несоответствие структуры документации и содержания разделов требованиям ГОСТ и других руководящих документов. Структура документов копируется из образцов, размещенных в сети Интернет. Исполнители фрагментарно знакомы с исходными текстами руководящих документов (ГОСТ, корпоративных стандартов);
  • дублирование и тиражирование (copy-paste) текста из технической части государственного контракта / договора во все отчетные материалы, отсутствие «реального» проектирования на бумаге. Зачастую все постановки на разработку ПО остаются в электронной почте / прикладных системах управления требованиями в неформализованном виде и в документацию не включаются;
  • несоответствие оформления документации установленным в государственном контракте / договоре требованиям. Документация не выдержана в едином стиле оформления, у Исполнителей отсутствует методология написания документации, включающая в себя шаблоны, автоматические средства форматирования документов и т. п.;
  • наличие грамматических ошибок. На наш взгляд является досадным недостатком, поскольку содержательная часть с орфографическими и пунктуационными ошибками изначально ставит под сомнение качество результата работ в целом.

Не спорим, человеческий фактор имеет место быть. Но хотелось бы дать напутствие исполнителям: 

Не пренебрегайте качеством документации! Внимательно проверяйте отчетные материалы перед передачей Заказчику! Не жалейте ресурсы на работы по технической коммуникации!

Ведь рынок информационных технологий так тесен.

 

Екатерина Зорина, Евгения Григорьева