Помимо использования, автоматизированную систему необходимо также устанавливать и настраивать. Каким образом решается этот вопрос (ГОСТ 34)?
Назначение руководства администратора
Проектная документация на автоматизированную систему очень важна, так как является определяющей в процессе разработки и представляет собой то видение системы, которое будет в дальнейшем реализовано. Однако, не менее важны и эксплуатационные документы, которые позволят использовать и обслуживать систему правильно, эффективно и с минимальными затратами.
Одним из необходимых в процессе эксплуатации системы документов является Руководство администратора. Роль администратора системы заключается в том, чтобы организовывать и поддерживать работу конечных пользователей, тогда как обеспечение технической работоспособности системы обычно обеспечивается другими людьми. Таким образом, администратор лишь управляет работой системы, например:
– выполняет определенные действия по настройке программы;
– управляет учетными записями пользователей;
– настраивает права доступа;
– исправляет ошибки в данных;
– обеспечивает информационную поддержку.
Состав типового руководства администратора
Указанный выше список может меняться и дополняться в зависимости от особенностей конкретной АС. Необходимо предусмотреть все возможные функции, которые будет выполнять администратор программы, и предоставить четкие и понятные инструкции для выполнения конкретных действий. Для этого в документ Руководство администратора обычно включают такие разделы, как:
– Описание области применения и способа использования системы.
– Описание логики работы системы в виде основных правил и принципов ее работы.
– Описание функций администратора и перечень операций, необходимых для выполнения каждой из функций.
– Подробное описание порядка и способа выполнения каждой из операций функции администратора.
– Описание вида и порядка действий по обслуживанию системы.
– Описание вероятных ошибок и неполадок в работе системы и способов их устранения.
Стандарты для руководства администратора
Содержание и оформление Руководства администратора как эксплуатационного документа также регулируется государственными стандартами, так что и здесь необходимо соблюдать их требования. Несмотря на то, что не существует отдельного ГОСТа на создание Руководства администратора, его структура и оформление регламентируется РД 50-34.698, где описаны общие требования к содержанию документации.
Заключение
В заключение хочется сказать, что, несмотря на все принципы и правила, у каждой системы всегда существуют особенности установки и настройки, которые нужно учесть в документации. Обратитесь к нам, и мы поможем вам преодолеть эти трудности и сэкономим ваше время!
– разработка руководства пользователя;
– создание руководства программиста;
– разработка руководства оператора.
Дата введения 2022-01-01
Предисловие
Цели, основные принципы и общие правила проведения работ по межгосударственной стандартизации установлены ГОСТ 1.0 «Межгосударственная система стандартизации. Основные положения» и ГОСТ 1.2 «Межгосударственная система стандартизации. Стандарты межгосударственные, правила и рекомендации по межгосударственной стандартизации. Правила разработки, принятия, обновления и отмены»
Сведения о стандарте
1 РАЗРАБОТАН Акционерным обществом «Всероссийский научно-исследовательский институт сертификации» (АО «ВНИИС») и Обществом с ограниченной ответственностью «Информационно-аналитический вычислительный центр» (ООО ИАВЦ)
2 ВНЕСЕН Федеральным агентством по техническому регулированию и метрологии
3 ПРИНЯТ Межгосударственным советом по стандартизации, метрологии и сертификации (протокол от 22 декабря 2020 г. N 58)
За принятие проголосовали:
| Краткое наименование страны по МК (ИСО 3166) 004-97 | Код страны по МК (ИСО 3166) 004-97 | Сокращенное наименование национального органа по стандартизации |
|---|---|---|
| Армения | АМ | ЗАО «Национальный орган по стандартизации и метрологии» Республики Армения |
| Беларусь | ВY | Госстандарт Республики Беларусь |
| Киргизия | KG | Кыргызстандарт |
| Россия | RU | Росстандарт |
| Узбекистан | UZ | Узстандарт |
| Украина | UA | Минэкономразвития Украины |
4 Приказом Федерального агентства по техническому регулированию и метрологии от 19 ноября 2021 г. N 1521-ст межгосударственный стандарт ГОСТ 34.201-2020 введен в действие в качестве национального стандарта Российской Федерации с 1 января 2022 г.
5 ВЗАМЕН ГОСТ 34.201-89
6 ИЗДАНИЕ (март 2022 г.) с Поправкой (ИУС N 3 2022 г.)
1 Область применения
Настоящий стандарт распространяется на автоматизированные системы (АС), используемые в различных сферах деятельности (управление, исследования, проектирование и т.п.), включая их сочетания, и устанавливает требования к видам, наименованию, комплектности и обозначению документов, разрабатываемых на стадиях создания АС.
В случае отсутствия выделения стадий (или деления на другие стадии) при создании АС перечень разрабатываемой документации и сроки ее представления определяются техническим заданием или совместным решением заказчика и разработчика.
2 Нормативные ссылки
В настоящем стандарте использованы нормативные ссылки на следующие межгосударственные стандарты:
ГОСТ 2.102 Единая система конструкторской документации. Виды и комплектность конструкторских документов
ГОСТ 2.113-75 Единая система конструкторской документации. Групповые и базовые конструкторские документы
ГОСТ 2.601 Единая система конструкторской документации. Эксплуатационные документы
_______________
1) В Российской Федерации действует ГОСТ Р 2.601-2019.
ГОСТ 19.101 Единая система программной документации. Виды программ и программных документов
ГОСТ 34.602 Информационная технология. Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы
Примечание — При пользовании настоящим стандартом целесообразно проверить действие ссылочных стандартов и классификаторов на официальном интернет-сайте Межгосударственного совета по стандартизации, метрологии и сертификации (www.easc.by) или по указателям национальных стандартов, издаваемым в государствах, указанных в предисловии, или на официальных сайтах соответствующих национальных органов по стандартизации. Если на документ дана недатированная ссылка, то следует использовать документ, действующий на текущий момент, с учетом всех внесенных в него изменений. Если заменен ссылочный документ, на который дана датированная ссылка, то следует использовать указанную версию этого документа. Если после принятия настоящего стандарта в ссылочный документ, на который дана датированная ссылка, внесено изменение, затрагивающее положение, на которое дана ссылка, то это положение применяется без учета данного изменения. Если ссылочный документ отменен без замены, то положение, в котором дана ссылка на него, применяется в части, не затрагивающей эту ссылку.
3 Виды и наименование документов
Состав видов документов, разрабатываемых на стадии «Исследование и обоснование создания АС», определяют исходя из требуемых результатов выполнения данной стадии (научно-технический отчет, тактико-техническое задание, технико-экономическое обоснование).
На стадии «Техническое задание» разрабатывают Техническое задание (ТЗ) на создание автоматизированной системы в соответствии с требованиями ГОСТ 34.602.
Допускается разрабатывать ТЗ на составные части системы (подсистемы, комплексы задач, программно-технические комплексы, компоненты технического и программного обеспечения и т.п.).
При необходимости могут разрабатываться другие документы, детализирующие отдельные требования к автоматизированной системе.
Виды документов, разрабатываемых на стадиях «Эскизный проект», «Технический проект», «Рабочая документация», приведены в таблице 1.
Таблица 1 — Виды документов, разрабатываемых на стадиях «Эскизный проект», «Технический проект», «Рабочая документация»
| Вид документа | Код документа | Назначение документа |
| Ведомость | В | Перечисление в систематизированном виде объектов, предметов и т.д. |
| Схема | С | Графическое изображение форм документов, частей, элементов системы и связей между ними в виде условных обозначений |
| Инструкция | И | Изложение состава действий и правил их выполнения пользователями и персоналом |
| Обоснование | Б | Изложение сведений, подтверждающих целесообразность принимаемых решений |
| Описание | П | Пояснение назначения системы, ее частей, принципов их действия и условий применения |
| Конструкторский документ | — | По ГОСТ 2.102 |
| Программный документ | — | По ГОСТ 19.101 |
Виды документов на программные средства, используемые при создании АС (ее частей), — по ГОСТ 19.101.
Виды документов на технические средства, используемые при создании АС (ее частей), — по ГОСТ 2.102 и по ГОСТ 2.601 в части эксплуатационных документов.
Наименования конкретных документов, разрабатываемых при проектировании АС в целом или ее части, приведены в таблице 2.
Таблица 2 — Наименования конкретных документов, разрабатываемых при проектировании АС в целом или ее части
| Стадия создания | Наименование документа | Код документа | Часть проекта | Принадлежность к | Дополнительные указания | |
|---|---|---|---|---|---|---|
| проектно- сметной доку- ментации | эксплуа- тационной докумен- тации | |||||
| ЭП | Ведомость эскизного проекта | ЭП* | ОР | — | — | — |
| Пояснительная записка к эскизному проекту | П1 | ОР | — | — | — | |
| ЭП | Схема организационной структуры | СО | ОР | — | — | Допускается включать в документ ПЗ или ПВ |
| ТП | Структурная схема комплекса технических средств | С1* | ТО | Х | — | Допускается включать в документ П9 |
| Схема функциональной структуры | С2* | ОР | — | — | При разработке документов С0, С1, С2, С3 на стадии ЭП допускается их включение в документ П1 | |
| Перечень заданий на разработку специализированных (новых) технических средств | В9 | ТО | Х | — | При разработке на стадии ТП допускается включать в документ П2 | |
| Схема автоматизации | С3* | ТО | Х | — | — | |
| Технические задания на разработку специализированных (новых) технических средств | — | ТО | — | — | В состав проекта не входят | |
| ТП | Задания на разработку строительных, электротехнических, санитарно-технических и других разделов проекта, подготовительные работы, связанные с созданием системы | — | ТО | Х | — | В состав проекта не входят |
| Ведомость технического проекта | ТП* | ОР | — | — | — | |
| Ведомость покупных изделий | ВП* | ОР | — | — | ||
| Перечень входных данных | В1 | ИО | — | — | — | |
| Перечень выходных данных | В2 | ИО | — | — | — | |
| Перечень заданий на разработку строительных, электротехнических, санитарно-технических и других разделов проекта, связанных с созданием системы | В3 | ТО | Х | — | Допускается включать в документ П2 | |
| Пояснительная записка к техническому проекту | П2 | ОР | — | — | Включает план мероприятий по подготовке объекта к вводу системы в эксплуатацию | |
| Описание автоматизируемых функций | П3 | ОР | — | — | — | |
| Описание постановки задач (комплекса задач) | П4 | ОР | — | — | Допускается включать в документы П2 или П3 | |
| Описание информационного обеспечения системы | П5 | ИО | — | — | — | |
| ТП | Описание организации информационной базы | П6 | ИО | — | — | — |
| Описание систем классификации и кодирования | П7 | ИО | — | — | — | |
| Описание массива информации | П8 | ИО | — | — | — | |
| Описание комплекса технических средств | П9 | ТО | — | — | Для задачи допускается включать в документ П6 по ГОСТ 19.101 | |
| Описание программного обеспечения | ПА | ПО | — | — | — | |
| Описание алгоритма (проектной процедуры) | ПБ | МО | — | — | Допускается включать в документы П2, П3 или П4 | |
| Описание организационной структуры | ПВ | ОО | — | — | — | |
| План расположения | С8 | ТО | Х | — | Допускается включать в документ П9 | |
| Ведомость оборудования и материалов | — | ТО | Х | — | — | |
| Локальный сметный расчет | Б2 | ОР | Х | — | — | |
| ТП, РД | Проектная оценка надежности системы | Б1 | ОР | — | — | — |
| Шаблон документа | С9 | ИО | — | Х | На стадии ТП допускается включать в документы П4 или П5 | |
| РД | Ведомость держателей подлинников | ДП* | ОР | — | — | — |
| Ведомость эксплуатационных документов | ЭД* | ОР | — | Х | — | |
| Спецификация оборудования | В4 | ТО | Х | — | — | |
| Ведомость потребности в материалах | В5 | ТО | Х | — | — | |
| Описание информационного массива | В6 | ИО | — | Х | — | |
| Описание базы данных | В7 | ИО | — | Х | — | |
| Локальная смета | Б3 | ОР | Х | — | — | |
| Методика (технология) автоматизированного проектирования | И1 | ОО | — | Х | — | |
| Технологическая инструкция | И2 | ОО | — | Х | — | |
| Руководство пользователя | И3 | ОО | — | Х | — | |
| РД | Инструкция по эксплуатации комплекса технических средств | ИЭ | ТО | — | Х | — |
| Схема соединения внешних проводок | С4* | ТО | Х | — | Допускается выполнять в виде таблиц | |
| Схема подключения внешних проводок | С5* | ТО | Х | — | То же | |
| Таблица соединений и подключений | С6 | ТО | Х | — | — | |
| Схема деления системы (структурная) | Е1* | ТО | — | — | — | |
| Чертеж общего вида | ВО* | ТО | Х | — | — | |
| Чертеж установки технических средств | СА | ТО | Х | — | — | |
| Схема принципиальная | СБ | ТО | Х | — | — | |
| Схема структурная комплекса технических средств | С1* | ТО | Х | — | — | |
| План расположения оборудования и проводок | С7 | ТО | Х | — | — | |
| Описание технологического процесса обработки данных (включая телеобработку) | ПГ | ОО | — | Х | — | |
| Общее описание системы | ПД | ОР | — | Х | — | |
| Программа и методика испытаний (компонентов, комплексов средств автоматизации, подсистем, систем) | ПМ* | ОР | — | — | — | |
| Формуляр | ФО* | ОР | — | Х | — | |
| Паспорт | ПС* | ОР | — | Х | — | |
|
* Документы, код которых установлен в соответствии с требованиями стандартов Единой системы конструкторской документации (ЕСКД). Примечания 1 В таблице приняты следующие обозначения: ЭП — эскизный проект; ТП — технический проект; РД — рабочая документация; ОР — общесистемные решения; ОО — решения по организационному обеспечению; ТО — решения по техническому обеспечению; ИО — решения по информационному обеспечению; ПО — решения по программному обеспечению; МО — решения по математическому обеспечению. 2 Знак «Х» означает принадлежность к проектно-сметной или эксплуатационной документации. 3 Номенклатуру документов одного наименования устанавливают в зависимости от принятых при создании системы проектных решений. 4 Код (обозначение) документов, отмеченных в графе «Принадлежность к проектно-сметной документации» знаком «Х», может быть установлен по требованиям стандартов Системы проектной документации для строительства (СПДС). |
В зависимости от применяемых методов проектирования и специфики создаваемых АС допускается:
- разрабатывать групповые и базовые документы в соответствии с разделами 1, 3, 4, 6 ГОСТ 2.113— 75;
- выпускать документы отдельными самостоятельными частями, соответствующими разделам основного документа;
- расширять номенклатуру документов, установленную настоящим стандартом.
При изготовлении несерийных компонентов комплексов средств автоматизации и на стадии «Ввод в действие» разрабатывают следующие организационно-распорядительные документы:
- акт завершения работ;
- акт приемки в опытную эксплуатацию;
- акт приемки в промышленную эксплуатацию;
- план-график работ;
- приказ о составе приемочной комиссии;
- приказ о проведении работ;
- программа работ;
- протокол испытаний;
- протокол согласования.
4 Комплектность документации
4.1 Перечень наименований разрабатываемых документов и их комплектность на систему и ее части определяется либо в техническом задании на создание автоматизированной системы (подсистемы), либо на начальных этапах ее создания.
Примечание — Комплектность проектно-сметных документов определяют в соответствии с правилами, установленными системой проектной документации для строительства.
4.2 На каждый комплект должна быть составлена ведомость документов.
4.3 Комплектность документации, обеспечивающей разработку, изготовление, приемку и монтаж технических средств, — по ГОСТ 2.102. Комплектность эксплуатационной документации на эти средства — по ГОСТ 2.601.
4.4 Комплектность документации на программные средства вычислительной техники — по ГОСТ 19.101.
4.5 При самостоятельной разработке составной части системы документы на нее комплектуют в соответствии с требованиями настоящего стандарта.
5 Обозначения документов
5.1 Каждому разработанному документу должно быть присвоено самостоятельное обозначение. Документ, выполненный на разных носителях данных, должен иметь одно обозначение. К обозначению документов, выполненных на машинных носителях, добавляют букву «М».
Заимствованным документам сохраняют ранее присвоенные обозначения.
5.2 Настоящие правила не распространяются на документы, правила обозначения которых регламентированы государственными стандартами других систем документации.
5.3 Обозначение документа имеет следующую структуру, показанную на рисунке 1.
5.3.1 Правила обозначения системы (части системы) приведены в приложении А.
5.3.2 Код документа состоит из двух буквенно-цифровых знаков. Код для документов, определенных настоящим стандартом, проставляют в соответствии с графой 3 таблицы 2. Код дополнительных документов формируют следующим образом: первый знак — буква, означающая вид документа согласно таблице 1, второй знак — цифра или буква, указывающая порядковый номер документа данного вида.
Код документа отделяют от предыдущего обозначения точкой.
Рисунок 1. Структура обозначения документа.
5.3.3 Порядковые номера документов одного наименования (два знака) присваивают, начиная со второго, и отделяют от предыдущего обозначения точкой.
5.3.4 Номер редакции документа присваивают, начиная со второй в порядке возрастания от 2 до 9, и отделяют от предыдущего значения точкой. Очередной номер редакции присваивают в случаях сохранения (не аннулирования) предыдущей редакции.
5.3.5 Номер части документа отделяют от предыдущего обозначения дефисом. Если документ состоит из одной части, то дефис не проставляют и номер части документа не присваивают.
5.3.6 Признак документа, выполненного на машинных носителях, вводят при необходимости. Букву «М» отделяют от предыдущего обозначения точкой.
Приложение А (рекомендуемое). Правила обозначения систем и их чертежей
А.1 Структура обозначения автоматизированной системы или ее части имеет вид, показанный на рисунке А.1.
Рисунок А.1. Структура обозначения АС
А.2 Код организации-разработчика представляет собой основной государственный регистрационный номер (ОГРН) из Единого государственного реестра юридических лиц (ЕГРЮЛ).
А.З Код классификационной характеристики системы или ее части (подсистемы, комплекса, компонента) присваивают в соответствии с правилами, установленными в отрасли.
А.4 Порядковый регистрационный номер системы (части системы) присваивает служба организации разработчика, ответственная за ведение картотеки и учет обозначений. Регистрационные номера присваивают с 001 до 999 по каждому коду регистрационной характеристики.
Скачать документ в формате .doc вы можете здесь.
Журавлев Денис
Когда и у кого возникает необходимость создания руководства пользователя по ГОСТ
Многие IT-компании, которые занимаются разработкой и сопровождением программного обеспечения и автоматизированных комплексов, сталкиваются с задачей создания пользовательской документации или руководств для своих продуктов в соответствии с требованиями ГОСТ.
Как правило, необходимость в наличии пользовательского руководства, составленного по ГОСТ, возникает при сотрудничестве с государственными организациями, крупными производствами и компаниями, при заказной разработке программного обеспечения по тендерам и госзаказам или при необходимости добавить программный продукт в «Единый реестр российских программ для электронных вычислительных машин и баз данных (реестр отечественного ПО)».
Какие ГОСТ используются при написании руководства пользователя приложения
Существует две серии (набора) стандартов, которые регламентируют набор создаваемых документов и правила их оформления при разработке автоматизированных систем, комплексов и программного обеспечения:
- ГОСТ 34 — Автоматизированные системы
- ГОСТ 19 — Единая система программной документации (ЕСПД)
С одной стороны, эти два стандарта конкурируют между собой, предлагаю различные варианты комплектности документации на проект. С другой стороны, они фокусируются на разных аспектах, и поэтому хорошо дополняют друг друга.
ГОСТ 34 главным образом определяет комплектность, виды, структуру и содержание создаваемых документов.
ГОСТ 19 в большей степени определяет правила оформления документов.
Поэтому, на практике часто используются сразу оба этих ГОСТа.
Руководство пользователя — основной документ для конечного пользователя
Если говорить именно о документации для конечного пользователя системы, то из перечня описываемых в ГОСТ 34 документов нас интересует «Руководство пользователя». В ГОСТ 19 аналогичный по смыслу документ называется «Руководство оператора», но для программного обеспечения чаще используется именно первый вариант.
Руководство пользователя поставляется с любым изделием, программой, системой. Он должен предоставлять пользователю информацию о свойствах продукта, его функциональности, способах использования и работе с ним.
Сложности написания руководства пользователя по ГОСТ
Для начинающего технического писателя или простого специалиста, которому неожиданно поручили написать руководство пользователя по ГОСТ, эта задача является серьезной проблемой.
Мало того, что необходимо изучить большое число нормативных документов, изобилующих перекрестными ссылками и написанных сложным, излишне канцелярским, почти юридическим языком, так еще необходимо выбрать оттуда требования, относящиеся именно к создаваемому виду документа. Затем, на протяжении всей работы, нужно постоянно контролировать соблюдение этих требований в рабочем документе, постоянно сверяясь со стандартами.
Обычно проблема усугубляется еще и нехваткой времени, так как писать пользовательскую документацию, к сожалению, часто принято в самом конце проекта, перед самым дедлайном — датой сдачи или запуска системы.
У опытного технического писателя документирование по ГОСТ, возможно, не вызовет серьезных затруднений. Однако, даже у него подготовка шаблонов новых документов, приведение к требованиями стандартов существующей документации или проверка финального документа на соответствие этим требованиям может занять существенное время.
Dr.Explain упрощает создание руководства пользователя по ГОСТ
Начиная с версии 5.5.1100 программа для создания пользовательской документации Dr.Explain предлагает функцию автоматизированной поддержки ГОСТ в проектах. Эта функция призвана значительно облегчить жизнь пользователям, перед которыми стоит задача создания руководства пользователя в соответствии с требованиями государственных стандартов.
В частности программа Dr.Explain контролирует и автоматизирует поддержку следующих требований стандартов:
- Наличие обязательных разделов документа “Руководство пользователя” [ГОСТ 34 РД 50-34.698-90]. Все разделы снабжаются пояснениями по их содержанию.
- Оформление титульных листов, аннотации и содержания [ГОСТ 19.105-78, 19.104-78].
- Параметры печатных страниц документа и расположение основных элементов на них [ГОСТ 19.106-78].
- Структуру и оформление колонтитулов [ГОСТ 19.106-78].
- Оформление текстовой части документа: стили шрифтов, абзацные отступы, межстрочные интервалы [ГОСТ 19.106-78].
- Формирование и оформление заголовков, разделов, перечислений (списков) [ГОСТ 19.106-78].
Управление функцией поддержки ГОСТ для проекта доступно в Настройках проекта в разделе Общие.
При включенном режиме поддержки ГОСТ для проекта соответствующие пользовательские настройки для печатаемых форматов RTF\DOC и PDF автоматически перекрываются программой, что гарантирует полное соответствие параметров выходных документов требованиям стандартов.
Для выходных форматов HTML и CHM будут использоваться пользовательские настройки вне зависимости от активности режима поддержки ГОСТ. Это снимает ограничение на свободную стилизацию этих форматов и позволяет, например, оформить онлайн-справку полностью в корпоративном или тематическом стиле.
Важно: Перед включением режима поддержки ГОСТ для уже существующих в формате Dr.Explain проектов необходимо сделать резервную копию gui-файла проекта.
Важно: Функция поддержки ГОСТ доступна в Dr.Explain только в русскоязычной версии интерфейса. Язык интерфейса программы выбирается в меню Настройки\Выбор языка программы (Options\Application language).
Создание нового руководства пользователя по ГОСТ
Для создания нового руководства пользователя по требованиям ГОСТ 34 в программе Dr.Explain можно использовать команды меню Файл \ Создать локальный проект — Руководство пользователя по ГОСТ 34 или Файл \ Создать общий проект на tiwri.com — Руководство пользователя по ГОСТ 34
или аналогичные кнопки на стартовом экране приложения.
Программа создаст новый проект, в котором уже присутствуют шаблон титульного листа, аннотация, оглавление и обязательные разделы, оформленные по ГОСТ.
В тексте каждого раздела будет приведена краткая инструкция-подсказка о том, что необходимо включить в данный раздел. Пользователю необходимо только наполнить разделы актуальным содержимым.
Настройки оформления для печатных форматов RTF/DOC и PDF будут выставлены в соответствии с требованиям ГОСТ 19.
Приведение существующей пользовательской документации в соответствие с требованиями ГОСТ
Также программа Dr.Explain позволяет привести существующую пользовательскую документацию в соответствии с требованиями ГОСТ.
Важно: Перед включением режима поддержки ГОСТ для уже существующих в формате Dr.Explain проектов необходимо сделать резервную копию gui-файла проекта.
Если исходная документация еще не ведется в Dr.Explain, а хранится в других форматах, первым шагом необходимо выполнить импорт существующих документов в программу. Dr.Explain поддерживает импорт документов из ряда популярных форматов. Команды импорта доступны как на стартовом окне программы, так и в меню Файл.
Затем необходимо включить режим поддержки ГОСТ в свойствах проекта описанным ранее способом.
Программа проверит структуру документа на наличие обязательных разделов и, если они отсутствуют, создаст их. Остальные существующие разделы, наличие которых не регламентировано ГОСТами, будут перенесены в скрытый от экспорта раздел “Старое дерево разделов”.
Пользователь должен будет перенести содержимое этих разделов или разделы целиком методом drag-n-drop в основное дерево проекта и отредактировать их по необходимости.
Как и в первом случае настройки оформления для печатных форматов RTF/DOC и PDF будут выставлены в соответствии с требованиям ГОСТ 19.
Создайте документацию, соответсвующую ГОСТ 19 и ГОСТ 34 в Dr.Explain бесплатно
Смотрите также
- Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации
ГОСТ 19.505-79
Группа Т55
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
Единая система программной документации
РУКОВОДСТВО ОПЕРАТОРА
Требования к содержанию и оформлению
Unified system for program documentation. Operation’s guide. Requirements for contents and form of presentation
МКС 35.080
Дата введения 1980-01-01
Постановлением Государственного комитета CCCР по стандартам от 12 января 1979 г. N 74 дата введения установлена 01.01.80
ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г. (ИУС 11-81).
Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство оператора», определенного ГОСТ 19.101-77.
Стандарт полностью соответствует СТ СЭВ 2096-80*.
(Измененная редакция, Изм. N 1).
1. ОБЩИЕ ПОЛОЖЕНИЯ
1.1. Структура и оформление программного документа устанавливаются в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным.
1.2. Руководство оператора должно содержать следующие разделы:
назначение программы;
условия выполнения программы;
выполнение программы;
сообщения оператору.
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
(Измененная редакция, Изм. N 1).
2. СОДЕРЖАНИЕ РАЗДЕЛОВ
2.1. В разделе «Назначение программы» должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.
2.2. В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т.п.).
2.3. В разделе «Выполнение программы» должны быть: указана последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, приведены описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.
2.2, 2.3. (Измененная редакция, Изм. N 1).
2.4. (Исключен, Изм. N 1).
2.5. В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.).
2.6. Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.
(Измененная редакция, Изм. N 1).
2.7. В приложения к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства.
(Введен дополнительно, Изм. N 1).