Правила размещения страниц документации

Каждому пользователю выделяется индивидуальный децимальный номер.

Схема формирования децимального номера спецификации

Конструкторские документы: МГУЛ.XXYYYZ.VVV

Программные документы: 643.МГУЛ.XXYYZ-VV

где

XX --- год поступления;

(Y)YY --- индивидуальный номер разработчика, выданный при регистрации;

Z --- номер изделия (продукта) конкретного разработчика;

(V)VV --- версия (вариант) изделия.

Документы должны размещаться в пространстве имён, сформированном по схеме:

doc:XXYY:

Имя файла документа спецификации должно быть сформировано по схемам:

doc:XXYY:MGUL.XXYYYZ.VVV
doc:XXYY:643.MGUL.XXYYZ-VV

соответственно для конструкторских и программных документов.

Для конструкторских документов по согласованию с администратором dokuwiki допускается форма

doc:XXYYY:MGUL.XXYYYZ.VVV

Остальные документы должны иметь имена, аналогичные спецификации с дописыванием необходимых обозначений типов документов латиницей. Символ пробела должен быть заменён символом подчёркивания (_). Например:

doc:XXYY:MGUL.XXYYYZ.VVVE3 --- схема электрическая принципиальная;

doc:XXYY:643.MGUL.XXYYZ-VV_12_01 --- текст программы.

Типы документов конструкторской документации

Различают документы:

текстовые;

графические:

чертежи;

схемы.

Обозначения текстовых документов

Основные документы

Тип документа	Код рус.	Код лат.
Спецификация	-	-
Технические условия	ТУ	TU
Программа и методика испытаний	ПМ	PM
Расчёты	РР	RR
Таблицы	ТБ	TB
Различные инструкции (см. таблицу <<Инструкции>> ниже)	Иxx, Дxx	Ixx, Dxx
Эксплуатационные документы
Руководство по эксплуатации	РЭ	RE
Инструкция по монтажу, пуску, регулированию изделия	ИМ	IM

Инструкции

Тип инструкции	Код рус.	Код лат.
Инструкция по использованию ЗИП	И1	I1
Инструкция по использованию группового ЗИП	И1.1
Инструкция по использованию ремонтного ЗИП	И1.2
Инструкция по настройке	И2
Инструкция по поверке	И3
Комплект карт рабочих режимов	Д4
Нормы расхода запасных частей	Д5
Нормы расхода материалов	Д6
Маркировочный чертёж	Д7
Заключение о технологичности	Д8
Перечень изобретений	Д9
Инструкция по транспортированию	И10
Инструкция по обслуживанию ... (для отдельных специалистов: электрика, радиста, механика и т. п.)	И11
Памятка по обращению	Д12
Инструкция по защите параметров (охраняемых)	И14
Инструкция по упаковыванию	И15
Ведомость размещения ЗИП и имущества	Д16
Ведомость эксплуатационных КИП	Д17
Ведомость КИП ремонтной базы	Д18
Карты проверки (ТЭЗ)	Д19
Формуляр	Д20
Инструкция ... (проведения различных специальных работ, в том числе проверок)	И21
Инструкция по размещению изделия на объектах	И22
Технические требования	Д23
Характеристика контролепригодности	Д24
Инструкция по консервации и хранению	И25
Сведения о драгоценных металлах	Д26
Ведомость замен	Д28
Карта окраски	Д29
Сведения о цветных металлах	Д30
Инструкция по технологической тренировке	И32
Патентный формуляр	Д34
Заключение о техническом уровне изделия	Д35
Конструкторская документация программного обеспечения	Д40
Данные программы контроля	Д41
Данные программирования	Д42
Инструкция по программированию микросхем	И43

Обозначение графических документов

Чертежи

Тип документа	Код рус.	Код лат.
Сборочный чертёж	СБ	SB
Чертёж общего вида	ВО	VO
Габаритный чертёж	ГЧ	GCH

Схемы

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

Виды схем

Вид	Код рус.	Код лат.
Электрическая	Э	E
Оптическая	Л	L
Энергетическая	Р	R
Деления	Е	e
Комбинированная	С	S

Типы схем

Тип	Код
Структурная	1
Функциональная	2
Принципиальная (полная)	3
Соединений (монтажная)	4
Подключения	5
Общая	6
Расположения	7
Объединённая	0

Например, E3 (Э3) --- схема электрическая принципиальная.

Типы документов программной документации

Тип документа	Код
Программные документы
Спецификация	-
Текст программы	12
Описание программы	13
Программа и методика испытаний	51
Эксплуатационные документы
Описание применения	31
Руководство системного программиста	32
Руководство программиста	33
Руководство оператора	34
Описание языка	35
Руководство по техническому обслуживанию	46
Другие документы	90-99