Документалист.ГОСТ – Telegram
Документалист.ГОСТ
26 subscribers
12 photos
1 file
9 links
Для разработчика документации автоматизированных систем и программного обеспечения по ГОСТ необходимо владеть базовыми определениями
Download Telegram
Онлайн-курс «Техническая документация в IT-проектах» (2020) от documentat.io

О чем:
- Цели и задачи документации с точки зрения проектного управления.
- Жизненные циклы технических документов. Процессы создания, рецензирования, хранения и публикации документации.
- Типичные виды инструментария создания, хранения и публикации документации. Их сравнение с точки зрения применимости к разным видам документационных процессов.
- Обзор современных документационных стандартов (ГОСТ и ISO/IEC/IEEE).
- Профессиональный профиль технического писателя. Что нужно, чтобы быть хорошим техписателем, куда расти опытному техписателю, как нанимать их себе в команду.

Лекция 1. Два определения технической документации.
https://youtu.be/w0DNTDE3EgE

Лекция 2. Техническая документация — проектный артефакт или процесс?
https://youtu.be/BG5yBiyZTRc

Лекция 3. Жизненные циклы технических документов
https://youtu.be/qF9hDviKBYM

Лекция 4. Требования к документационному инструментарию.
https://youtu.be/Sawz84gY4Uk

Лекция 5. Введение в DocOps
https://youtu.be/1CuMeMYwtbg

Лекция 6. Docs as code на примере Foliant
https://youtu.be/6CKVodl2YcA

Лекция 7. ГОСТ 19 в современной разработке
https://youtu.be/1P18VkS7ORQ

Лекция 8. Help Authoring Tools на примере MadCap Flare
https://youtu.be/6fAQ1HC5fqI

Лекция 9. Локализация документации
https://youtu.be/UYRKX1ZuUzw

Лекция 10. ГОСТ 34 в современной разработке, часть 1
https://youtu.be/Cb7oyeIjWZ8

Лекция 11. ГОСТ 34 в современной разработке, часть 2
https://youtu.be/NLXbsE_HOJY

Лекция 12. ГОСТ 34 в современной разработке, часть 3
https://youtu.be/O9896hB0DSM
Формуляр (программный документ)

Составление информационной части (аннотации и содержания) является обязательным.

В основную часть формуляра должны входить разделы:
- общие указания;
- общие сведения;
- основные характеристики;
- комплектность;
- периодический контроль основных характеристик при эксплуатации и хранении;
- свидетельство о приемке;
- свидетельство об упаковке и маркировке;
- гарантийные обязательства;
- сведения о рекламациях;
- сведения о хранении;
- сведения о закреплении программного изделия при эксплуатации;
- сведения об изменениях;
- особые отметки;
- приложения.

= Изучаемый документ =
ГОСТ 19.501-78
Описание применения

Составление информационной части (аннотации и содержания) является обязательным.

Текст описания применения должен состоять из разделов:
- назначение программы;
- условия применения;
- описание задачи;
- входные и выходные данные.

= Изучаемый документ =
ГОСТ 19.502-78
Руководство системного программиста

Составление информационной части (аннотации и содержания) является обязательным.

Руководство системного программиста должно содержать разделы:
- общие сведения о программе;
- структура программы;
- настройка программы;
- проверка программы;
- дополнительные возможности;
- сообщения системному программисту.

= Изучаемый документ =
ГОСТ 19.503-79
Руководство программиста

Составление информационной части (аннотации и содержания) является обязательным.

Руководство программиста должно содержать следующие разделы:
- назначение и условия применения программы;
- характеристики программы;
- обращение к программе;
- входные и выходные данные;
- сообщения.

= Изучаемый документ =
ГОСТ 19.504-79
Руководство оператора

Составление информационной части (аннотации и содержания) является обязательным.

Руководство оператора должно содержать следующие разделы:
- назначение программы;
- условия выполнения программы;
- выполнение программы;
- сообщения оператору.

= Изучаемый документ =
ГОСТ 19.505-79
Ведомость эксплуатационных документов

Составление информационной части (аннотации и содержания) является необязательным.

В ведомости перечисляют документы, входящие в перечень эксплуатационных программных документов.

Ведомость эксплуатационных документов должна содержать разделы:
- документы на программу;
- документы на составные части программы.

Ведомость эксплуатационных документов на компонент, имеющий самостоятельное применение, должна содержать только раздел "Документы на программу"

= Изучаемый документ =
ГОСТ 19.507-79
Руководство по техническому обслуживанию

Составление информационной части (аннотации и содержания) является обязательным.

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

В зависимости от особенностей документа допускается вводить дополнительные разделы.

= Изучаемый документ =
ГОСТ 19.508-79
Порядок документирования программных средств систем вооружения

Вопросу посвящен раздел 7 ГОСТ Р 51189-98. Хочу обратить внимание на пп. 7.7 - 7.9:
7.7 Программная документация на все ПССВ и их покупные программные компоненты должна быть выполнена на русском языке.

7.8 Эксплуатационная ПД на ПССВ должна быть выполнена в соответствии с требованиями стандартов ЕСПД и настоящего стандарта.

7.9 Проектную ПД на ПССВ выполняют по стандартам ЕСПД.


В реальной жизни эти требования могут привести и приводят к разработке документации на русском языке на покупное иностранное ПО. Мне довелось делать русскоязычную документацию на СУБД в составе документации которой не было текста программы, но была лицензия на DB2.

= Изучаемый документ =
ГОСТ Р 51189-98 раздел 7
Росстандарт_8262.pdf
3.4 MB
Требования к содержанию документов АС

РД 50-34.698-90 - недействующий.

Во вложении письмо Росстандарта.

В конце 2020 года завершено исполнение контракта "Разработка и подготовка к утверждению стандартов в области информационных технологий".

Выписал из контракта перечень стандартов на АС :
Информационная технология. Комплекс стандартов на автоматизированные системы. Виды, комплектность и обозначение документов при создании автоматизированных систем
Пересмотр ГОСТ 34.201-89

Информационная технология. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Термины и определения
Пересмотр ГОСТ 34.003-90

Информационная технология. Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы
Пересмотр ГОСТ 34.602-89
Технические условия

В соответствии с ГОСТ 2.102 являются КД, содержащим требования (совокупность всех показателей, норм, правил и положений) к изделию, его изготовлению, контролю, приемке и поставке, которые нецелесообразно указывать в других КД;

В соответствии с ГОСТ 19.101 содержат требования к изготовлению, контролю и приемке программы.

В общем случае ТУ должны содержать вводную часть и разделы, расположенные в следующей последовательности:
- технические требования;
- требования безопасности;
- требования охраны окружающей среды;
- правила приемки;
- методы контроля (испытаний);
- указания по эксплуатации, в том числе требования хранения, транспортирования и утилизации изделия;
- гарантии изготовителя.

Для изделий ВВТ есть особенности построения ТУ, с которыми при необходимости можно ознакомиться в ГОСТ РВ 20.39.301-98 "Комплексная система общих технических требований (КСОТТ). Аппаратура, приборы, устройства, оборудование военной техники (АПУОВТ). Общие требования, методы обеспечения и оценки соответствия требованиям. Основные положения."

=Изучаемые документы=
ГОСТ 2.114
ГОСТ 19.101 п. 2.7
ГОСТ РВ 20.39.301-98 п. 7.4.2, 7.4.3, 9.5
ГОСТ РВ 20.39.415-97 (не применим к изделиям разработка которых началась после 2020 г. )
Схемы. Виды и типы

Наименование и код схемы определяют их видом и типом

Виды схем в зависимости от видов элементов и связей (вид - код вида):
- электрическая - Э;
- гидравлическая - Г;
- пневматическая - П;
- газовая (кроме пневматической схемы) - Х;
- кинематическая - К;
- вакуумная - В;
- оптическая - Л;
- энергетическая - Р;
- деления - Е;
- комбинированная - С.

Виды схем в зависимости от основного назначения (тип - код типа):
- структурная - 1;
- функциональная - 2;
- принципиальная (полная) - 3;
- соединений (монтажная) - 4;
- подключения - 5:
- общая - 6:
- расположения - 7;
- объединенная - 0.

Примеры:
- схема электрическая принципиальная - Э3;
- схема гидравлическая соединений - Г4;
- схема деления структурная - Е1;
- схема электрогидравлическая принципиальная - С3;
- схема электрическая соединений и подключения - Э0.

=Изучаемый документ=
ГОСТ 2.701
Схемы (дополнение)

Для разных видов схем есть отдельные стандарты:
- ГОСТ 2.702-2011 ЕСКД. Правила выполнения электрических схем;
- ГОСТ 2.703-2011 ЕСКД. Правила выполнения кинематических схем;
- ГОСТ 2.704-2011 ЕСКД. Правила выполнения гидравлических и пневматических схем;
- ГОСТ 2.705-70 ЕСКД. Правила выполнения электрических схем обмоток и изделий с обмотками;
- ГОСТ 2.707-84 ЕСКД. Правила выполнения электрических схем железнодорожной сигнализации, централизации и блокировки;
- ГОСТ 2.708-81 ЕСКД. Правила выполнения электрических схем цифровой вычислительной техники;
- ГОСТ 2.709-89 Обозначения условные проводов и контактных соединений электрических элементов, оборудования и участков цепей в электрических схемах;
- ГОСТ 2.710-81 ЕСКД. Обозначения буквенно-цифровые в электрических схемах;
- ГОСТ Р 2.711-2019 ЕСКД. Схема деления изделия на составные части.
Порядок хранения, учета и дублирования документации

Для конструкторской документации ГОСТ 2.501-2013 Правила учета и хранения и ГОСТ 2.502-2013 Правила дублирования
На основании этих стандартов могут быть (и разрабатываются) стандарты организаций, учитывающие особенности процессов организаций.

Для программной документации ГОСТ 19.602-78 Правила дублирования, учета и хранения программных документов, выполненных печатным способом.
Штамп учета и хранения подлинников выполняется техническим писателем в процессе разработки документа.

Для документов АСУ ГОСТ 24.402-80 Система технической документации на АСУ. Учет, хранение и обращение

Для конструкторских, программных, технологических и других проектных документов выполненных на магнитных носителях данных ГОСТ 28388-89 Системы обработки информации. Документы на магнитных носителях данных. Порядок выполнения и обращения
В реальной жизни данным стандартом пользуются при использовании оптических носителей: CD, DVD, BD

=Изучаемые документы=
ГОСТ 2.501
ГОСТ 2.502
ГОСТ 19.602
ГОСТ 24.402-80
ГОСТ 28388 раздел 9
Channel name was changed to «Документалист.ГОСТ»
Внесение изменений в документы конструкторские, АСУ

Под изменением документа понимается любое исправление, исключение или добавление каких-либо данных в этот документ.

Причины изменений:
Введение улучшений и усовершенствований:
- конструктивных (1)
- технологических (2)
- в результате стандартизации и унификации (3)
Внедрение и изменение стандартов и технических условий (4)
По результатам испытаний (5)
Отработка документов с изменением литеры (6)
Устранение ошибок (7)
Улучшение качества (8)
Требования заказчика (представительства заказчика) (9)
Изменение схемы (10)
Улучшение электрического монтажа (11)
Изменение средств технологического оснащения (12)
Изменение условий труда (13)
Введение новых технологических процессов (операций) (14)
Замена исходной заготовки (15)
Изменение норм расхода материалов (16)

Примечание - в скобках указан код причины изменения по ГОСТ 2.503

Порядок внесения изменений в копии эксплуатационных и ремонтных документов, переданных заказчику в соответствии с ГОСТ 2.603

Изменение в документы АСУ вносят в соответствии с ГОСТ 2.503, с учетом дополнительных требований ГОСТ 24.401-80, например, изменения на каждый документ оформляют отдельным извещением. Допускается оформлять одно общее извещение на изменения, проводимые одновременно в нескольких документах, если изменения взаимосвязаны или одинаковы для всех изменяемых документов и совпадает срок их внесения в документы;

Правила внесения изменений для документов выполненных на магнитных носителях данных по ГОСТ 28388-89
В реальной жизни данным стандартом пользуются при использовании оптических носителей: CD, DVD, BD

=Изучаемые документы=
ГОСТ 2.503
ГОСТ 2.603
ГОСТ 24.401-80
ГОСТ 28388 раздел 11
Внесение изменений в программные документы

Процесс аналогичный процессу внесения изменений в конструкторские документы.

Согласно п. 2.5 ГОСТ 19.603 извещение может иметь приложения. Приложения могут содержать части, предназначенные для осуществления указанных изменений, в том числе и с помощью ЭВМ.

=Изучаемые документы=
ГОСТ 19.603
ГОСТ 19.604
Порядок проверки, согласования и утверждения КД
Литерность документации (для изделий ВТ)


=Изучаемый документ=
ГОСТ РВ 2.902-2005