Инструменты пользователя
Это старая версия документа!
Содержание
Правила размещения страниц документации
Каждому пользователю выделяется индивидуальный децимальный номер.
Схема формирования децимального номера спецификации
- Конструкторские документы: МГУЛ.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 |
Инструкции
| Тип инструкции | Код рус. | Код лат. |
|---|
Обозначение графических документов
Чертежи
| Тип документа | Код рус. | Код лат. |
|---|---|---|
| Сборочный чертёж | СБ | 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 |
Инструменты страницы
