Уточнение требований к оформлению комплекта документов заключается в выборе шаблона оформления, формата и носителя технической документации. Правила оформления техдокументации регламентируются ГОСТ 2.004, ГОСТ 2.104-2.106, ГОСТ 19.106, ГОСТ 34.602 и рядом других нормативных документов. Редакция от 12.03.2021.

Создан 18.10.2009 17:51:08

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

Выбор шаблона оформления технической документации

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

• стандартные (соответствующие требованиям перечисленных выше ГОСТов) шаблоны;
• шаблоны на основе корпоративного стиля оформления.

В компании «Техническая документация», в силу специфики поступающих заказов, применяются, как правило, наборы стандартных шаблонов, прошедших нормоконтроль и многократно использованных при разработке технической документации под различные проекты. Один из таких шаблонов представлен на рисунке.

Шаблоны на основе корпоративного стиля оформления заимствуются, как правило, из любого типового документа, предоставленного заказчиком. Подготовка такого шаблона занимает совсем немного времени, как и «переключение» всего комплекта документов с одного шаблона на другой.

Выбор носителя технической документации

Носитель техдокументации, как известно, может быть бумажным (печатным) и электронным («непечатным») На электронном носителе комплект технической документации может быть представлен в виде файлов различных форматов.

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

Нередактируемые (напрямую) форматы - pdf и т.п. - предпочтительнее для окончательного варианта документа. В них можно работать в режиме рецензирования без внесения изменений в собственно текст документа.

Электронные документы предоставляют читателю массу удобств - возможность быстрого поиска информации по структуре документа, по поисковому запросу (как в информационно-поисковых системах).

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

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