Уточнение требований к оформлению комплекта документов

Уточнение требований к оформлению комплекта документов включает в себя:

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

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

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

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

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

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

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

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

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

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

Файлы различных форматов могут быть редактируемыми и нередактируемыми. Редактируемые форматы предпочтительнее для работ, связанных с внесением изменений по замечаниям заказчика, но в качестве завершающего электронного документа они малопригодны. Одно неосторожное движение - и можно потерять всю информацию. К таким файлам относятся те, что продуцируются распространенными текстовыми редакторами (и в них же просматриваются), например OpenOffice - *.odt, *.doc и иные.

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

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

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

Заказать услуги, установить контакты со специалистами компании можно по электронной почте admin собака tdocs точка su, по ICQ UIN 481-726-610 или с помощью формы «Контакты». Вопросы некоммерческого характера могут быть заданы в Форуме проектировщиков и разработчиков технической документации.