Общие требования к выполнению текстовых документов АСУ
ГОСТ 24.301-80 - распространяется на техническую документацию на АСУ всех видов, разрабатываемые для всех уровней управления (кроме общегосударственного), и устанавливает общие требования к выполнению текстовых документов, перечень которых установлен ГОСТ 34.201.
Стандарт не распространяется на программные и организационно-распорядительные документы АСУ, правила выполнения которых регламентированы государственными стандартами других систем документации.
= Изучаемый документ =
ГОСТ 24.301-80
ГОСТ 24.301-80 - распространяется на техническую документацию на АСУ всех видов, разрабатываемые для всех уровней управления (кроме общегосударственного), и устанавливает общие требования к выполнению текстовых документов, перечень которых установлен ГОСТ 34.201.
Стандарт не распространяется на программные и организационно-распорядительные документы АСУ, правила выполнения которых регламентированы государственными стандартами других систем документации.
= Изучаемый документ =
ГОСТ 24.301-80
Общие требования, комплектность и правила составления ЭД информационно-измерительных систем (ИИС)
ГОСТ 27300-87 - распространяется на электронные измерительные приборы и вспомогательные устройства [функциональные единицы (приборы)], предназначенные для построения ИИС, используемых для решения задач автоматизации измерений; эксплуатационные документы для ИИС, устанавливает комплектность и правила их составления.
= Изучаемый документ =
ГОСТ 27300-87
ГОСТ 27300-87 - распространяется на электронные измерительные приборы и вспомогательные устройства [функциональные единицы (приборы)], предназначенные для построения ИИС, используемых для решения задач автоматизации измерений; эксплуатационные документы для ИИС, устанавливает комплектность и правила их составления.
= Изучаемый документ =
ГОСТ 27300-87
Оформление эксплуатационных документов
ГОСТ 2.601-2013 Утратил силу в РФ
ГОСТ Р 2.601-2019 - устанавливает виды, комплектность и общие требования к выполнению эксплуатационных документов.
Виды эксплуатационных документов:
- Руководство по эксплуатации
- Инструкция по монтажу, пуску, регулированию и обкатке изделия
- Формуляр
- Паспорт
- Этикетка
- Каталог изделия
- Нормы расхода запасных частей
- Нормы расхода материалов
- Ведомость комплекта запасных частей, инструмента и принадлежностей
- Учебно-технические плакаты
- Инструкции эксплуатационные специальные
- Ведомость эксплуатационных документов
= Изучаемый документ =
ГОСТ Р 2.601-2019
ГОСТ 2.601-2013 Утратил силу в РФ
ГОСТ Р 2.601-2019 - устанавливает виды, комплектность и общие требования к выполнению эксплуатационных документов.
Виды эксплуатационных документов:
- Руководство по эксплуатации
- Инструкция по монтажу, пуску, регулированию и обкатке изделия
- Формуляр
- Паспорт
- Этикетка
- Каталог изделия
- Нормы расхода запасных частей
- Нормы расхода материалов
- Ведомость комплекта запасных частей, инструмента и принадлежностей
- Учебно-технические плакаты
- Инструкции эксплуатационные специальные
- Ведомость эксплуатационных документов
= Изучаемый документ =
ГОСТ Р 2.601-2019
Порядок записи сведений о драгоценных материалах в ЭД
Наименование и порядок записи сведений в ЭД:
- о драгоценных материалах по ГОСТ 2.608-78;
- о цветных металлах по ГОСТ Р 54564-2011.
= Изучаемые документы =
ГОСТ Р 2.601-2019 раздел 7
ГОСТ 2.608-78
ГОСТ Р 54564-2011
Наименование и порядок записи сведений в ЭД:
- о драгоценных материалах по ГОСТ 2.608-78;
- о цветных металлах по ГОСТ Р 54564-2011.
= Изучаемые документы =
ГОСТ Р 2.601-2019 раздел 7
ГОСТ 2.608-78
ГОСТ Р 54564-2011
ВТ. Эксплуатационные документы
Стандарт распространяется на изделия ВТ и устанавливает требования к их эксплуатационным документам, разрабатываемым на электронных и бумажных носителях, применяется совместно с ГОСТ Р 2.601-2019.
= Изучаемый документ =
ГОСТ РВ 0002-601-2008
Стандарт распространяется на изделия ВТ и устанавливает требования к их эксплуатационным документам, разрабатываемым на электронных и бумажных носителях, применяется совместно с ГОСТ Р 2.601-2019.
= Изучаемый документ =
ГОСТ РВ 0002-601-2008
Порядок оформления ПД
Основные надписи по ГОСТ 19.104
Общие требования к ПД по ГОСТ 19.105
Требования к ПД, выполненным печатным способом по ГОСТ 19.106
ПД состоит из следующих условных частей:
- Титульная часть:
— Лист утверждения
— Титульный лист
- Информационная часть:
— Аннотация
— Содержание
- Основная часть:
— Текст документа
— Приложения
— Перечень терминов
— Перечень сокращений
— Перечень рисунков
— Перечень таблиц
— Предметный указатель
— Перечень ссылочных документов
— Перечень символов и числовых коэффициентов
- Часть регистрации изменений:
— Лист регистрации изменений
= Изучаемые документы =
ГОСТ 19.104, ГОСТ 19.105, ГОСТ 19.106
Основные надписи по ГОСТ 19.104
Общие требования к ПД по ГОСТ 19.105
Требования к ПД, выполненным печатным способом по ГОСТ 19.106
ПД состоит из следующих условных частей:
- Титульная часть:
— Лист утверждения
— Титульный лист
- Информационная часть:
— Аннотация
— Содержание
- Основная часть:
— Текст документа
— Приложения
— Перечень терминов
— Перечень сокращений
— Перечень рисунков
— Перечень таблиц
— Предметный указатель
— Перечень ссылочных документов
— Перечень символов и числовых коэффициентов
- Часть регистрации изменений:
— Лист регистрации изменений
= Изучаемые документы =
ГОСТ 19.104, ГОСТ 19.105, ГОСТ 19.106
ТЗ на разработку программы или программного изделия
ТЗ по ГОСТ 19.201 должно содержать следующие разделы:
- введение;
- основания для разработки;
- назначение разработки;
- требования к программе или программному изделию;
- требования к программной документации;
- технико-экономические показатели;
- стадии и этапы разработки;
- порядок контроля и приемки.
в ТЗ допускается:
- включать приложения;
- уточнять содержание разделов, вводить новые разделы или объединять отдельные из них.
Содержание разделов в стандарте.
= Изучаемый документ =
ГОСТ 19.201
ТЗ по ГОСТ 19.201 должно содержать следующие разделы:
- введение;
- основания для разработки;
- назначение разработки;
- требования к программе или программному изделию;
- требования к программной документации;
- технико-экономические показатели;
- стадии и этапы разработки;
- порядок контроля и приемки.
в ТЗ допускается:
- включать приложения;
- уточнять содержание разделов, вводить новые разделы или объединять отдельные из них.
Содержание разделов в стандарте.
= Изучаемый документ =
ГОСТ 19.201
Спецификация (ПД)
Спецификация в общем случае должна содержать разделы:
- документация;
- комплексы;
- компоненты.
Наименование каждого раздела указывают в виде заголовка в графе "Наименование". Для документов, выполненных печатным способом, заголовок подчеркивают.
После каждого раздела спецификации необходимо оставлять несколько свободных строк для дополнительных записей.
Требования к заполнению разделов в стандарте.
= Изучаемый документ =
ГОСТ 19.202
Спецификация в общем случае должна содержать разделы:
- документация;
- комплексы;
- компоненты.
Наименование каждого раздела указывают в виде заголовка в графе "Наименование". Для документов, выполненных печатным способом, заголовок подчеркивают.
После каждого раздела спецификации необходимо оставлять несколько свободных строк для дополнительных записей.
Требования к заполнению разделов в стандарте.
= Изучаемый документ =
ГОСТ 19.202
Программы и методики испытаний
У многих людей происходит смещение до степени сходства документов:
- Программа и методика испытаний по ЕСПД - ГОСТ 19. 301-79;
- Программа и методика испытаний по ЕСКД - ГОСТ Р 2.106-2019;
- Программа и методики испытаний по СРПП - ГОСТ РВ 15.211-2002.
Больше пока сказать не могу... Завал
У многих людей происходит смещение до степени сходства документов:
- Программа и методика испытаний по ЕСПД - ГОСТ 19. 301-79;
- Программа и методика испытаний по ЕСКД - ГОСТ Р 2.106-2019;
- Программа и методики испытаний по СРПП - ГОСТ РВ 15.211-2002.
Больше пока сказать не могу... Завал
Текст программы
ГОСТ 19.401-78 устанавливает требования к программному документу "Текст программы"
Если в ТЗ есть требование соответствия ЕСПД, но здравый смысл подсказывает, что печатать символическую запись на исходном языке не лучшая идея.
Несколько раз приходилось так делать🤯🤦🏻♂️
Как правило текст программы оформляют документами на "магнитном носителе". О чем должна быть отметка в перечне (комплектности).
RU.АБВГ.ХХХХХ-ХХ 12 01 - Текст программы. Исходный модуль
RU.АБВГ.ХХХХХ-ХХ 12 02 - Текст программы. Загрузочный модуль
RU.АБВГ.ХХХХХ-ХХ-УД - Удостоверяющий лист
Удостоверяющий лист по ГОСТ 28388-89. Системы обработки информации. Документы на магнитных носителях данных. Порядок выполнения и обращения
Примечания:
1) по умолчанию ГОСТ 28388-89 используют для документов на оптических носителях: CD, DVD
2) не забудьте выпустить листы утверждения на каждый ПД Текст программы
= Изучаемые документы =
ГОСТ 19.401-78, ГОСТ 28388-89, ГОСТ 19.103-77
ГОСТ 19.401-78 устанавливает требования к программному документу "Текст программы"
Если в ТЗ есть требование соответствия ЕСПД, но здравый смысл подсказывает, что печатать символическую запись на исходном языке не лучшая идея.
Несколько раз приходилось так делать🤯🤦🏻♂️
Как правило текст программы оформляют документами на "магнитном носителе". О чем должна быть отметка в перечне (комплектности).
RU.АБВГ.ХХХХХ-ХХ 12 01 - Текст программы. Исходный модуль
RU.АБВГ.ХХХХХ-ХХ 12 02 - Текст программы. Загрузочный модуль
RU.АБВГ.ХХХХХ-ХХ-УД - Удостоверяющий лист
Удостоверяющий лист по ГОСТ 28388-89. Системы обработки информации. Документы на магнитных носителях данных. Порядок выполнения и обращения
Примечания:
1) по умолчанию ГОСТ 28388-89 используют для документов на оптических носителях: CD, DVD
2) не забудьте выпустить листы утверждения на каждый ПД Текст программы
= Изучаемые документы =
ГОСТ 19.401-78, ГОСТ 28388-89, ГОСТ 19.103-77
Описание программы
ПД как правило разрабатывают на этапе сертификации и содержит разделы:
- общие сведения;
- функциональное назначение;
- описание логической структуры;
- используемые технические средства;
- вызов и загрузка;
- входные данные;
- выходные данные.
= Изучаемый документ =
ГОСТ 19.402-78
ПД как правило разрабатывают на этапе сертификации и содержит разделы:
- общие сведения;
- функциональное назначение;
- описание логической структуры;
- используемые технические средства;
- вызов и загрузка;
- входные данные;
- выходные данные.
= Изучаемый документ =
ГОСТ 19.402-78
Пояснительная записка
ПД разрабатывают на стадиях эскизного и технического проектирования. Содержит разделы:
- введение;
- назначение и область применения;
- технические характеристики;
- ожидаемые технико-экономические показатели;
- источники, использованные при разработке.
Содержание разделов приведено в стандарте.
= Изучаемый документ =
ГОСТ 19.404-79
ПД разрабатывают на стадиях эскизного и технического проектирования. Содержит разделы:
- введение;
- назначение и область применения;
- технические характеристики;
- ожидаемые технико-экономические показатели;
- источники, использованные при разработке.
Содержание разделов приведено в стандарте.
= Изучаемый документ =
ГОСТ 19.404-79
Онлайн-курс «Техническая документация в 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
О чем:
- Цели и задачи документации с точки зрения проектного управления.
- Жизненные циклы технических документов. Процессы создания, рецензирования, хранения и публикации документации.
- Типичные виды инструментария создания, хранения и публикации документации. Их сравнение с точки зрения применимости к разным видам документационных процессов.
- Обзор современных документационных стандартов (ГОСТ и 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.501-78
Описание применения
Составление информационной части (аннотации и содержания) является обязательным.
Текст описания применения должен состоять из разделов:
- назначение программы;
- условия применения;
- описание задачи;
- входные и выходные данные.
= Изучаемый документ =
ГОСТ 19.502-78
Составление информационной части (аннотации и содержания) является обязательным.
Текст описания применения должен состоять из разделов:
- назначение программы;
- условия применения;
- описание задачи;
- входные и выходные данные.
= Изучаемый документ =
ГОСТ 19.502-78
Руководство системного программиста
Составление информационной части (аннотации и содержания) является обязательным.
Руководство системного программиста должно содержать разделы:
- общие сведения о программе;
- структура программы;
- настройка программы;
- проверка программы;
- дополнительные возможности;
- сообщения системному программисту.
= Изучаемый документ =
ГОСТ 19.503-79
Составление информационной части (аннотации и содержания) является обязательным.
Руководство системного программиста должно содержать разделы:
- общие сведения о программе;
- структура программы;
- настройка программы;
- проверка программы;
- дополнительные возможности;
- сообщения системному программисту.
= Изучаемый документ =
ГОСТ 19.503-79
Руководство программиста
Составление информационной части (аннотации и содержания) является обязательным.
Руководство программиста должно содержать следующие разделы:
- назначение и условия применения программы;
- характеристики программы;
- обращение к программе;
- входные и выходные данные;
- сообщения.
= Изучаемый документ =
ГОСТ 19.504-79
Составление информационной части (аннотации и содержания) является обязательным.
Руководство программиста должно содержать следующие разделы:
- назначение и условия применения программы;
- характеристики программы;
- обращение к программе;
- входные и выходные данные;
- сообщения.
= Изучаемый документ =
ГОСТ 19.504-79
Руководство оператора
Составление информационной части (аннотации и содержания) является обязательным.
Руководство оператора должно содержать следующие разделы:
- назначение программы;
- условия выполнения программы;
- выполнение программы;
- сообщения оператору.
= Изучаемый документ =
ГОСТ 19.505-79
Составление информационной части (аннотации и содержания) является обязательным.
Руководство оператора должно содержать следующие разделы:
- назначение программы;
- условия выполнения программы;
- выполнение программы;
- сообщения оператору.
= Изучаемый документ =
ГОСТ 19.505-79
Ведомость эксплуатационных документов
Составление информационной части (аннотации и содержания) является необязательным.
В ведомости перечисляют документы, входящие в перечень эксплуатационных программных документов.
Ведомость эксплуатационных документов должна содержать разделы:
- документы на программу;
- документы на составные части программы.
Ведомость эксплуатационных документов на компонент, имеющий самостоятельное применение, должна содержать только раздел "Документы на программу"
= Изучаемый документ =
ГОСТ 19.507-79
Составление информационной части (аннотации и содержания) является необязательным.
В ведомости перечисляют документы, входящие в перечень эксплуатационных программных документов.
Ведомость эксплуатационных документов должна содержать разделы:
- документы на программу;
- документы на составные части программы.
Ведомость эксплуатационных документов на компонент, имеющий самостоятельное применение, должна содержать только раздел "Документы на программу"
= Изучаемый документ =
ГОСТ 19.507-79