Инструменты пользователя

Инструменты сайта


doc:decim_nums

Это старая версия документа!


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

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

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

  • Конструкторские документы: МГУЛ.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 — текст программы.

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

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

  • текстовые;
  • графические:
    • чертежи;
    • схемы.

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

Тип документа Код рус. Код лат.

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

Тип документа Код
Программные документы
Спецификация -
Текст программы 12
Описание программы 13
Программа и методика испытаний 51
Эксплуатационные документы
Описание применения 31
Руководство системного программиста 32
Руководство программиста 33
Руководство оператора 34
Описание языка 35
Руководство по техническому обслуживанию 46
Другие документы 90-99
doc/decim_nums.1489436545.txt.gz · Последние изменения: 2018/04/28 23:47 (внешнее изменение)