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

Создан 04.11.2006 12:56:01

Разработка техдокументации на изделия, программные изделия и автоматизированные системы (АС) предполагает подготовку целого ряда концептуальных, отчетных, проектных, рабочих, эксплуатационных и организационно-распорядительных документов согласно требованиям ГОСТов 34-й системы и иных нормативно-технических документов (НТД). Суммарный объем документации, включающей в себя значительное количество текстовой и графической информации, нередко исчисляется сотнями и тысячами, а зачастую десятками и сотнями тысяч страниц.

Разработка и поддержание техдокументации в актуальном состоянии на всех стадиях и этапах жизненного цикла изделия или АС вызывают немало проблем, связанных, в основном, с необходимостью многократного внесения в документацию, состоящую из множества отдельных файлов Microsoft Word, всевозможных поправок, дополнений и изменений. Ручная корректировка значительного числа многостраничных документов - операция трудоемкая, требующая от исполнителя аккуратности, высокой сосредоточенности, отнимающая массу времени, сил и нервов.

Люди - не автоматы. Монотонные и однообразные действия, выполняемые людьми, неизбежно оборачиваются бесчисленным множеством нелепых и досадных ошибок, допускаемых в документах, что, в свою очередь, сводит качество технической документации к нулю.

Некий горе-руководитель высказался по поводу качества технической документации вполне определенно - «по мне - да пусть там себе копошатся, лишь бы подготовили к сроку чего-нибудь». Результат не заставил себя ждать - заказчики отказались согласовывать документы, как следствие - проплачивать последующие стадии и этапы работ, компания перешла в режим глубокой экономии с задержками зарплаты, началась волна увольнений по собственному желанию1. Руководитель «отмахнулся» от объективной реальности, не пожелал учесть, что время работы «по понятиям» уходит2.

Ситуация отягощается еще и тем, что:

  • «государственный» заказчик, финансирующий львиную долю разрабатываемых АС и являющийся наиболее щедрым, надежным и неиссякаемым источником финансирования, все чаще и чаще требует от исполнителя строжайшего и неформального соблюдения ГОСТов при разработке технической документации;
  • требования отечественных ГОСТов несоизмеримо более жесткие по сравнению с требованиями зарубежных стандартов и сопоставимы, пожалуй, лишь с требованиями стандартов MIL3;
  • специалистов «советской школы», способных удовлетворить растущие требования заказчика, в силу объективных причин остается все меньше и меньше, подрастающее же поколение продолжает воспитываться в рамках так называемого «процессного подхода», навязываемого западными проповедниками бучевского толка - в этой связи вопросам изучения отечественных ГОСТов в ВУЗах внимания почти не уделяется.

Автоматизация рутинных операций при разработке технической документации - единственный разумный путь, гарантирующий высокое качество технической документации, существенное сокращение сроков ее разработки, снижение трудоемкости поддержания комплекта документов в актуальном состоянии. В настоящее время имеются все предпосылки для решения задачи автоматизации разработки и сопровождения техдокументации.

Примечания от 19.08.2014:

  1. Увольнялось да 30 % сотрудников ежемесячно, набирали новых. Через полгода компания приказала долго жить, полностью сдав все позиции в области электронного документооборота конкурентам.
  2. Многие так и продолжают работать, если не пилят госбюджет. Те, над кем зависает Счетная палата, поумнели и требуют разработку идеальной документации по ГОСТам.
  3. «Это какой-то позор...» В июне 2014 года введено более сотни совершенно невменяемых национальных стандартов, гармонизированных с ИСО. В результате пересмотра очень сильно пострадала Единая система конструкторской документации (ЕСКД).