О технической документации (часть 1). Стандарты документации
Это цикл статей, посвященный разработке технической документации:
Введение >> Часть 1 >> Часть 2 >> Часть 3 >> Часть 4 >> Часть 5
Какие стандарты технической документации используются сегодня?
В настоящее время на территории СНГ действуют следующие серии стандартов документирования в области ИТ: ГОСТ 19 (ЕСПД), ГОСТ 34 (КСАС) и ГОСТ 2 (ЕСКД). Как правило, ГОСТ 19 применяется для описания программного обеспечения, ГОСТ 34 используется для документирования автоматизированных систем, а ГОСТ 2 – для всего остального.
С 2006 года в соответствии с Федеральным законом О техническом регулировании (№184-ФЗ) применение государственных стандартов технической документации стало необязательным – вместо них должны применяться соответствующие регламенты. Однако в некоторых случаях все же придется применять ГОСТы. Например, в случае разработки комплекта документов для государственного заказчика всегда требуется предоставлять документы, выполненные в соответствии с требованиями ГОСТ
19, ГОСТ 34 или ГОСТ 2. Если же ваш заказчик крупная организация (в особенности с государственным участием), разработавшая собственные регламенты предприятия, то также велика вероятность, что концептуальные положения этих регламентов будут соответствовать указанным ГОСТам. Также во многих случаях ГОСТы продолжают применять по историческим причинам (в особенности на предприятиях, руководителям которых ГОСТы были привиты еще во времена прошлого века).
СНГ
В СНГ значительная часть стандартов не обновлялась с конца XX века, что не может ни сказываться отрицательно на актуальности определенных правил и методик. Прежде всего, это касается оформления документов, терминологии, условных обозначений и ведения архива. Однако стоит отметить, в стандартах СНГ достаточно неплохо отражены концептуальные моменты, что позволяет успешно создавать на их основе современные регламенты и шаблоны. Более того, в соответствии с законом О техническом регулировании национальные стандарты технической документации имеют приоритет над международными, а использовать международные регламенты необходимо только в том случае, если их положения не противоречат национальным.
США
В США несколько иной подход к унификации в целом и стандартам технической документации в частности. Основное отличие – вхождение представителей бизнеса в лице компаний-лидеров в комитеты, ответственные за принятие, пересмотр и отмену регламентов. Причем действующие стандарты технической документации всегда пересматриваются и дополняются актуальным опытом через определенный промежуток времени (раз в 5-7 лет). Результатом являются достаточно детализированные и, что особенно важно, актуальные форматы. В целом, если сравнивать стандарты США со стандартами СНГ, в стандартах США свободы действий меньше, но они более конкретизированы по умолчанию.
Итого
В настоящее время многие крупные IT-компании на территории СНГ создали и развивают собственные стандарты технической документации. Разрабатываются такие стандарты обычно на основе нормативной базы, которая адаптирована к реалиям и опыту конкретной IT-компании. Причем эти регламенты распространяются не только на сами компании, но и, как правило, на контрагентов-исполнителей компании.
Совет №1: Выбрать ГОСТы, в соответствии с которыми планируется разработка документа, всегда лучше до начала разработки, т.к. ГОСТы определяют не только оформление, но и содержание, а также методику подачи материала. Ознакомиться и полистать основные стандарты технической документации можно на нашем портале в разделе Стандарты.