Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
разбивка руководства пользователя на тома по подсистемам
 
Пишу РП на Портал. В зависимости от роли пользователя Портал делится на подсистемы (открытая часть, ЛК, администратор и
т.д.). Хочу разбить РП на тома, т.к. документы предназначены для разных групп пользователей (хотя некоторые разделы там и дублируются). Как правильно оформить тома (титульный лист, нумерация, обозначение). Где можно посмотреть ГОСТ по этому поводу?
 
ГОСТ 2.1-05-95: п.4.1.1:
Текст документа при необходимости разделяют на разделы и подразделы. При большом объеме документа допускается разделять его на части, а части, в случае необходимости, на книги. Каждую часть и книгу комплектуют отдельно. Всем частям дают наименования и присваивают обозначение документа. Начиная со второй части, к этому обозначению добавляют порядковый номер, например: ХХХХ.331112.032Ф0, ХХХХ.331112.032Ф01, ХХХХ.331112.032Ф02 и т. д. Всем книгам дают наименование и присваивают порядковый номер. Пример заполнения поля 4 титульного листа на книгу приведен в приложении Б. Листы документа нумеруют в пределах каждой части, каждую часть начинают на листах с основной надписью по форме ГОСТ 2.104 и форме 3 ГОСТ 21.101.

ГОСТ 19.103-77 (переиздание 87 г.): п. 8:
Номер части одного и того же документа присваивают в порядке возрастания с 1 до 9.
Примечание. Если документ состоит из одной части, то дефис и порядковый номер части не указывают.

ГОСТ 34.201-89: п.3.3.5:
Номер части документа отделяют от предыдущего обозначения дефисом. Если документ состоит из одной части, то дефис не проставляют и номер части документа не присваивают.
 
Обязательных стандартов для оформления не существует. По требованию заказчика или в добровольном порядке вы можете использовать любые правила. Хотите - можете применять любые ГОСТы, ОСТы, собственные спецификации или "Генеральный регламент" 1720 года.

Например, если портал является программой (комплексом программ), можете применять ГОСТы 19 серии на программную документацию.

Тогда правила оформления титульных листов задаются ГОСТ 19.104-78, всего лишь 37-летней давности.

Нумерация документов может выполняться по ГОСТ 19.103-77. Документы имеют простые и легко запоминаемые номера вида:

A.B.CCCCC-DD EE FF-G

Здесь:
A - код страны, например RU (по стандарту ISO 3166-1)
B - код организации-разработчика. Например, код ОКПО
CCCCC - регистрационный номер программы, который должен присваиваться "в соответствии с Общесоюзным классификатором программ, утверждаемым Госстандартом в установленном порядке". Поскольку Госстандарт и этот порядок давно почили в бозе, можете присвоить его себе сами.
DD - номер редакции документа
EE - код вида документа в соответствии с ГОСТ 19.101-77:
  • 05 Ведомость держателей подлинников
  • 12 Текст программы
  • 13 Описание программы
  • 20 Ведомость эксплуатационных документов
  • 30 Формуляр
  • 31 Общее описание
  • 32 Руководство системного программиста
  • 33 Руководство программиста
  • 34 Руководство оператора
  • 35 Описание языка
  • 46 Руководство по техническому обслуживанию
  • 51 Порядок и методика испытаний
  • 81 Пояснительная записка
  • 90 Документы прочие
FF - номер документа данного вида
G - номер части документа

Начальная часть обозначения A.B.CCCCC-DD может использоваться для обозначения самой программы.
Изменено: Виктор Фигурнов - 11.08.2015 16:45:33
 
Цитата
Виктор Фигурнов написал:
Тогда правила оформления титульных листов задаются ГОСТ 19.104-78, всего лишь 37-летней давности
Вообще-то он сейчас 2010 года (дата последнего издания 2010-03-04). Так что ему только 5 годков исполнилось :D
Страницы: 1
Читают тему