Предпосылки к автоматизации разработки технической документации с применением AuthorIT

Создан 04.11.2006 21:04:22

Из Приложения 1 ГОСТ 34.201-89: «Документация на автоматизированную систему - комплекс взаимоувязанных (курсив мой - Авт.) документов, в котором полностью описаны все решения по созданию и функционированию системы, а также документов, подтверждающих соответствие системы требованиям технического задания и готовность ее к эксплуатации (функционированию)».

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

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

- Жесткие связи между структурными единицами документов на АС

Каждый из трех указанных документов, как правило, представлен отдельным файлом Microsoft Word, поэтому даже однократное изменение текста требования ТЗ приведет к ручной корректировке еще двух документов. Казалось бы - не беда, но во что обернутся трудозатраты, если изменения в ТЗ придется вносить многократно? А если указанный текст содержится не в трех, а в шести (порой и более) документах, как, например, подраздел «Перечень объектов автоматизации» ТЗ по ГОСТ 34.602-89, имеющий также место в документах П2, П4, ПД, И3 и Б1 (коды по ГОСТ 34.201-89).

Выводы:

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

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

  1. Есть еще одно определение документации на АС - «Комплект взаимоувязанных документов, полностью определяющих технические требования к АС, проектные и организационные решения по созданию и функционированию АС [из п. 5.1 ГОСТ 34.003-90]». Автору оно представляется более симпатичным, поэтому слово комплекс здесь и далее заменено на слово комплект.
  2. Качеству техдокументации на еще одном нашем сайте http://tdocs.su посвящен огромный раздел.

Как показала практика, избавиться от рутинной работы, исключить бессмысленные трудозатраты, требуемые на корректировку большого числа отдельных документов Microsoft Word, реализовать многократное использование идентичных фрагментов для достижения стопроцентной согласованности документов возможно с применением инструментария разработки, построенного на основе концепции единого источника - single source. Одним из наиболее удобных инструментов, основанных на указанной концепции, является программа AuthorIT компании AuthorIT Software Corporation Ltd.