Створення шаблону документації

Розглянемо докладніше, як формується шаблон документації і його склад.

Документація створюється в рамках визначеного шаблону, що є типовою формою для створення ЕЕД. Для розробки такого шаблону необхідно:

· проведення аналізу існуючої нормативної бази;

· проведення аналізу самого виробу, технічних умов і вимог замовника.

Мета підготовки шаблонів:

· уніфікація оформлення даних;

· зменшення трудомісткості робіт з форматування текстової і графічної інформації при розробці модульних даних.

Уніфікація оформлення даних досягається за рахунок поділу модулів даних на визначені варіанти. Наприклад, модуль типу “Описова інформація” може мати наступні варіанти:

· “Загальні відомості”;

· “Будова і робота”;

· “Технічні характеристики”.

Для кожного варіанту можуть бути, в свою чергу, створені необхідні варіанти оформлення.

Наприклад шаблон структури «Керівництво з експлуатації», побудованого відповідно до вимог стандарту ДСТ 2.601-95, може складатися із семи розділів. У шаблоні заздалегідь проставлені їхні назви, послідовність і правила використання (рис. 2).

Рис. 2.

Наприклад, розділ «Поточний ремонт» може бути відсутній у ЕЕД на конкретний виріб, якщо цей виріб не ремонтується. Ця властивість розділу відбита в шаблоні структури у вигляді модифікатора.

В залежності від правил використання, при побудові шаблону структури застосовуються модифікатори, представлені в табл. 1.

Таблиця 1

Модифікатори для побудови шаблону структури ЕЕД

Модифікатор	Правило використання
	Елемент може бути присутнім у структурі в одному екземплярі чи може бути відсутнім
	В структурі може бути присутні необмежена кількість екземплярів елемента
	Елемент може бути присутнім в одному (чи більш) екземплярі
Пустий модифікатор	Елемент може бути присутнім в структурі в одному екземплярі

На кожен розділ створюється структура, тобто свій визначений шаблон. Розділи складаються з МД. Для МД також можуть створюватися типові шаблони.

Також у ЕЕД може створюватися:

· словники термінів, скорочень, визначень, а також стандарти.

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

Створення і використання словників допомагає скоротити час на розробку документації.

· бібліотека елементів оформлення документації.

Вона представляє собою стандартні елементи графічного оформлення — логотип підприємства і піктограми.

Словники і бібліотека представляють собою перелік текстових фрагментів багаторазового використання.

Після цього розробка шаблону документації закінчується. Далі здійснюється перехід до процесу створення ЕЕД.

Дата добавления: 2014-01-07