Сегодня пытаемся освоить управление программной документацией.
Сразу обращаю внимание, что при управлении ПД в данной статье руководствуемся требованиями ГОСТ серии 19.ХХХ. При ссылках в Ваших ТТЗ, контрактах на другие ДС – необходимо руководствоваться требования именно этих ДС.
Как всегда, определяемся с терминами.
программный документ: Документ, содержащий сведения, необходимые для разработки, изготовления, эксплуатации и сопровождения программного изделия.
программное изделие: Программа на носителе данных, являющаяся продуктом промышленного производства.
Целями процедуры управления программной документацией, как правило, являются:
- - обеспечение подразделений и должностных лиц организации необходимой ПД для решения производственных задач по выпуску продукции надлежащего качества и в установленные сроки;
- - обеспечение сохранения ПД в доступном и пригодном состоянии.
Управление программной документацией, разрабатываемой в организации, включает следующие этапы:
- - разработка, включающая в себя идентификацию, проверки на стадии разработки, согласование и утверждение ПД;
- - учет и распределение;
- - внедрение;
- - внесение изменений;
- - хранение и изъятие из обращения.
Управление программной документацией, поступившей от внешних организаций, включает следующие этапы:
- - получение и регистрация;
- - распределение;
- - изготовление необходимого количества копий, их учет и рассылка;
- - внедрение;
- - внесение изменений;
- - хранение и изъятие из обращения.
Программная документация, разработанная в нашем гипотетическом ООО «ООО» и (или) поступившая от внешних организаций, относится к документам, необходимым для функционирования СМК ООО «ООО» и ее процессов.
Программная документация, разработанная в организации, относится к документам, составляющим документированную часть знаний ООО «ООО».
При управлении ПД в ООО «ООО» могут применяться системы автоматизированного проектирования и управления документами.
Разработка программной документации
Общие положения
Разработка программной документации организации производится бюро ПД конструкторского отдела или внешней организацией.
Разрабатываемая ПД является выходом процесса «Управление проектированием и разработкой» (СТО …).
Стадии разработки, этапы и содержание работ при разработке ПД должны соответствовать указанным в приложении QQQ.
Стадии разработки, этапы и содержание работ при разработке программных средств систем вооружения дополнительно должны соответствовать ГОСТ Р 51189.
Техническое задание
Техническое задание выполняется подразделением-заказчиком программной документации либо внешним заказчиком.
Техническое задание оформляют в соответствии с ГОСТ 19.106 на листах формата А3 и А4 по ГОСТ 2.301 без заполнения полей листа. Номера листов (страниц) проставляются в верхней части листа над текстом.
Лист утверждения и титульный лист оформляют в соответствии с ГОСТ 19.104. Информационную часть (аннотацию и содержание), лист регистрации изменений допускается в документ не включать.
Для внесения изменений или дополнений в техническое задание на последующих стадиях разработки программы или программного изделия выпускают дополнение к нему. Согласование и утверждение дополнения к техническому заданию проводят в том же порядке, который установлен для технического задания.
Техническое задание должно содержать следующие разделы:
- - введение;
- - основания для разработки;
- - назначение разработки;
- - требования к программе или программному изделию;
- - требования к программной документации;
- - технико-экономические показатели;
- - стадии и этапы разработки;
- - порядок контроля и приемки.
В техническое задание допускается включать приложения. В зависимости от особенностей программы или программного изделия допускается уточнять содержание разделов, вводить новые разделы или объединять отдельные из них.
В разделе «Введение» указывают наименование, краткую характеристику области применения программы или программного изделия и объекта, в котором используют программу или программное изделие.
В разделе «Основания для разработки» должны быть указаны:
- - документ (документы), на основании которых ведется разработка;
- - организация, утвердившая этот документ, и дата его утверждения;
- - наименование и (или) условное обозначение темы разработки.
В разделе «Назначение разработки» должно быть указано функциональное и эксплуатационное назначение программы или программного изделия.
Раздел «Требования к программе или программному изделию» должен содержать следующие подразделы:
- - требования к функциональным характеристикам;
- - требования к надежности;
- - условия эксплуатации;
- - требования к составу и параметрам технических средств;
- - требования к информационной и программной совместимости;
- - требования к маркировке и упаковке;
- - требования к транспортированию и хранению;
- - специальные требования.
В подразделе «Требования к функциональным характеристикам» должны быть указаны требования к составу выполняемых функций, организации входных и выходных данных, временным характеристикам и т. п.
В подразделе «Требования к надежности» должны быть указаны требования к обеспечению надежного функционирования (обеспечения устойчивого функционирования, контроль входной и выходной информации, время восстановления после отказа и т.п.).
В подразделе «Условия эксплуатации» должны быть указаны условия эксплуатации (температура окружающего воздуха, относительная влажность и т.п. для выбранных типов носителей данных), при которых должны обеспечиваться заданные характеристики, а также вид обслуживания, необходимое количество и квалификация персонала.
В подразделе «Требования к составу и параметрам технических средств» указывают необходимый состав технических средств с указанием их основных технических характеристик.
В подразделе «Требования к информационной и программной совместимости» должны быть указаны требования к информационным структурам на входе и выходе и методам решения, исходным кодам, языкам программирования и программным средствам, используемым программой.
При необходимости должна обеспечиваться защита информации и программ.
В подразделе «Требования к маркировке и упаковке» в общем случае указывают требования к маркировке программного изделия, варианты и способы упаковки.
В подразделе «Требования к транспортированию и хранению» должны быть указаны для программного изделия условия транспортирования, места хранения, условия хранения, условия складирования, сроки хранения в различных условиях.
В разделе «Требования к программной документации» должен быть указан предварительный состав программной документации и, при необходимости, специальные требования к ней.
В разделе «Технико-экономические показатели» должны быть указаны: ориентировочная экономическая эффективность, предполагаемая годовая потребность, экономические преимущества разработки по сравнению с лучшими отечественными и зарубежными образцами или аналогами.
В разделе «Стадии и этапы разработки» устанавливают необходимые стадии разработки, этапы и содержание работ (перечень программных документов, которые должны быть разработаны, согласованы и утверждены), а также, как правило, сроки разработки и определяют исполнителей.
В разделе «Порядок контроля и приемки» должны быть указаны виды испытаний и общие требования к приемке работы.
В приложениях к техническому заданию, при необходимости, приводят:
- - перечень научно-исследовательских и других работ, обосновывающих разработку;
- - схемы алгоритмов, таблицы, описания, обоснования, расчеты и другие документы, которые могут быть использованы при разработке;
- - другие источники разработки.
На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемке программы.
Эскизный проект
На стадии выполнения эскизного проекта производится предварительная разработка структуры входных и выходных данных, уточнение методов решения задачи, разработка общего описания алгоритма решения задачи и технико-экономического обоснования.
Результаты указанных работ приводятся в пояснительной записке.
Пояснительная записка оформляется разработчиком ПД на стадии согласования и утверждения эскизного проекта.
Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105. Составление информационной части (аннотация и содержание) не является обязательным.
Пояснительная записка должна содержать следующие разделы:
- - введение;
- - назначение и область применения;
- - технические характеристики;
- - ожидаемые технико-экономические показатели;
- - источники, использованные при разработке.
В зависимости от особенностей документа отдельные разделы (подразделы) допускается объединять, а также вводить новые разделы (подразделы).
В разделе «Введение» указывают наименование программы и (или) условное обозначение темы разработки, а также документы, на основании которых ведется разработка с указанием организации и даты утверждения.
В разделе «Назначение и область применения» указывают назначение программы, краткую характеристику области применения программы.
Раздел «Технические характеристики» должен содержать следующие подразделы:
- - постановка задачи на разработку программы, описание применяемых математических методов и, при необходимости, описание допущений и ограничений, связанных с выбранным математическим материалом;
- - описание алгоритма и (или) функционирования программы с обоснованием выбора схемы алгоритма решения задачи, возможные взаимодействия программы с другими программами;
- - описание и обоснование выбора метода организации входных и выходных данных;
- - описание и обоснование выбора состава технических и программных средств на основании проведенных расчетов и (или) анализов, распределение носителей данных, которые использует программа.
В разделе «Ожидаемые технико-экономические показатели» указывают технико-экономические показатели, обосновывающие выбранного варианта технического решения, а также, при необходимости, ожидаемые оперативные показатели.
В разделе «Источники, использованные при разработке» указывают перечень научно-технических публикаций, нормативно-технических документов и других научно-технических материалов, на которые есть ссылки в основном тексте.
В приложение к пояснительной записке могут быть включены таблицы, обоснования, методики, расчеты и другие документы, использованные при разработке.
Технический проект
На стадии выполнения технического проекта уточняются структуры входных и выходных данных, разрабатывается алгоритм решения задачи, определяются формы представления входных и выходных данных, разрабатывается структура программы, определяются семантика и синтаксис языка, производится окончательное определение конфигурации технических средств.
Оформление работ по техническому проекту производится разработчиком ПД следующими документами:
- - план мероприятий по разработке и внедрению программ;
- - пояснительная записка.
План мероприятий разрабатывается в соответствии с приложением WWW.
Пояснительная записка оформляется в соответствии с требованиями ГОСТ 19.404, с учетом специфики выполненных работ.
Рабочий проект
На стадии выполнения рабочего проекта разработчиком ПД выполняются:
- - разработка программы;
- - разработка программной документации;
- - испытания программы.
Виды программных документов и их содержание приведены в приложении RRR.
Виды эксплуатационных документов и их содержание приведены в приложении YYY.
В зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию (по ГОСТ 2.102), предназначенные для разработки, сопровождения и эксплуатации программы.
Виды программных документов, разрабатываемых на стадии рабочего проекта, и их коды приведены в приложении UUU.
Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов. В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ.
Необходимость разработки технических условий, содержащих требования к изготовлению, контролю и приемке программы, определяют в техническом задании.
Требования к оформлению программных документов
● Спецификация
Структура и оформление спецификации устанавливаются в соответствии с ГОСТ 19.105, ГОСТ 19.202.
Информационную часть (аннотацию и содержание) допускается в спецификации не включать.
Спецификация является основным программным документом для компонентов, применяемых самостоятельно, и для комплексов.
Для компонентов, не имеющих спецификации, основным программным документом является «Текст программы».
Спецификация, в общем случае, должна содержать разделы:
- - документация;
- - комплексы;
- - компоненты.
Наименование каждого раздела указывают в виде заголовка в графе «Наименование». Для документов, выполненных печатным способом, заголовок подчеркивают.
В раздел «Документация» вносят программные документы на данную программу, кроме спецификации и технического задания, в порядке возрастания кода вида документа, входящего в обозначение.
Далее записывают заимствованные программные документы. Запись их производится в порядке возрастания кодов организаций-разработчиков и далее в порядке возрастания кода вида документа, входящего в обозначение.
После каждого раздела спецификации необходимо оставлять несколько свободных строк для дополнительных записей.
Графы спецификаций заполняют следующим образом:
- в графе «Обозначение» указывают:
а) в разделе «Документация» - обозначение записываемых документов программы;
б) в разделе «Комплексы» - обозначения спецификацией комплексов, входящих в данный комплекс;
в) в разделе «Компоненты» - обозначения основных программных документов компонентов;
- в графе «Наименование» указывают:
а) в разделе «Документация» - наименование и вид документа для документов на данную программу; полное наименование программы, наименование и вид документа для заимствованных документов;
б) в разделах «Комплексы» и «Компоненты» - полное наименование программы, наименование и вид документа;
- в графе «Примечание» - дополнительные сведения, относящиеся к записанным в спецификации программам.
При отсутствии места в графе «Примечание» допускается записывать только порядковые номера примечаний. Текст примечаний записывают в конце соответствующих разделов спецификации. Допускается текст примечаний записывать на последних листах спецификации, на листах без граф с проставлением порядкового номера примечания.
В графе «Обозначение» запись производят в одну строку. В остальных графах спецификации записи допускаются в несколько строк.
● Ведомость держателей подлинников
Структура и оформление ведомости держателей подлинников устанавливаются в соответствии с ГОСТ 19.105, ГОСТ 19.403. Составление информационной части (аннотации и содержания) является необязательным.
Ведомость составляют на основании спецификации программы и спецификаций входящих программ.
В начале ведомости записывают спецификации, подлинники которых хранятся в организации-держателе подлинника спецификации программ, на которую составляется ведомость.
Далее записывают спецификации, подлинники которых хранятся в других организациях.
Запись спецификаций для входящих программ производят под заголовком «Документация на входящие программы» без перечисления входящих в них программных и ссылочных документов.
Для ведомостей, выполненных печатным способом, в графе «Наименование» заголовок подчеркивают.
Спецификации записывают в ведомости в порядке возрастания кодов организаций-разработчиков.
Графы ведомости заполняют следующим образом:
- - в графе «Обозначение» указывают обозначение спецификаций по ГОСТ 19.103;
- - в графе «Наименование» приводят полное наименование программы в соответствии с наименованием, указанным на листе утверждения или титульном листе;
- - в графе «Держатель подлинника» указывают ведомственную принадлежность (при наличии) и, в установленном порядке, наименование организации-держателя подлинника.
- - в графе «Примечание» указывают, при необходимости, дополнительные сведения.
● Текст программы
Структуру и оформление текста программы устанавливают в соответствии с ГОСТ 19.105, ГОСТ 19.401.
Составление информационной части (аннотация и содержание) является необязательным. Для текста программы на исходном языке при наличии аннотации в нее включают краткое описание функций программы.
Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования.
Допускается вводить наименования также и для совокупности разделов.
Каждый из этих разделов реализуется одним из типов символической записи, например:
- - символическая запись на исходном языке;
- - символическая запись на промежуточных языках;
- - символическое представление машинных кодов и т.п.
В символическую запись разделов рекомендуется включать комментарии, которые могут отражать, например, функциональное назначение, структуру.
● Описание программы
Структуру и оформление описания программы устанавливают в соответствии с ГОСТ 19.105, ГОСТ 19.402.
Составление информационной части (аннотации и содержания) является обязательным.
Описание программы должно содержать следующие разделы:
- - общие сведения;
- - функциональное назначение;
- - описание логической структуры;
- - используемые технические средства;
- - вызов и загрузка;
- - входные данные;
- - выходные данные.
В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.
В разделе «Общие сведения» должны быть указаны:
- - обозначение и наименование программы;
- - программное обеспечение, необходимое для функционирования программы;
- - языки программирования, на которых написана программа.
В разделе «Функциональное назначение» должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.
В разделе «Описание логической структуры» должны быть указаны:
- - алгоритм программы;
- - используемые методы;
- - структура программы с описанием функций составных частей и связи между ними;
- - связи программы с другими программами.
Описание логической структуры программы выполняют с учетом текста программы на исходном языке.
В разделе «Используемые технические средства» должны быть указаны типы электронно-вычислительных машин и устройств, которые используются при работе программы.
В разделе «Вызов и загрузка» должны быть указаны:
- - способ вызова программы с соответствующего носителя данных;
- - входные точки в программу.
Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.
В разделе «Входные данные» должны быть указаны:
- - характер, организация и предварительная подготовка входных данных;
- - формат, описание и способ кодирования входных данных.
В разделе «Выходные данные» должны быть указаны:
- - характер и организация выходных данных;
- - формат, описание и способ кодирования выходных данных.
Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками.
В приложения к описанию программы допускается включать различные материалы, которые нецелесообразно включать в разделы описания.
● Ведомость эксплуатационных документов
Структуру и оформление ведомости эксплуатационных документов устанавливают в соответствии с ГОСТ 19.105, ГОСТ 19.507.
Составление информационной части (аннотация и содержание) не является обязательным.
В ведомости перечисляют документы, входящие в перечень эксплуатационных программных документов.
Ведомость эксплуатационных документов должна содержать следующие разделы:
- - документы на программу;
- - документы на составные части программы.
Ведомость эксплуатационных документов на компонент, имеющий самостоятельное применение, должна содержать только раздел «Документы на программу».
В разделе «Документы на программу» должны быть записаны все эксплуатационные документы (кроме ведомости эксплуатационных документов) на данную программу.
В разделе «Документы на составные части программы» должны быть записаны ведомости эксплуатационных документов на все программы ‒ непосредственно входящие в программу.
Запись документов в ведомости производят под заголовками разделов в графе «Наименование».
Для документов, выполненных печатным способом, заголовок подчеркивают.
Документы записывают в ведомости в порядке возрастания кода вида документа, входящего в обозначение.
Графы ведомости заполняют следующим образом:
- - в графе «Обозначение» указывают обозначение документов по ГОСТ 19.103;
- - в графе «Наименование» указывают полное наименование эксплуатационного документа в соответствии с наименованием, указанным на листе утверждения или титульном листе.
Для документов на данную программу записывают только наименование и вид документов:
- - в графе «Кол. экз.» указывают количество экземпляров данного документа;
- - в графе «Местонахождение» указывают номер папки, в которой хранится документ, выполненный печатным способом.
Допускается записывать текст примечаний и дополнительные сведения, относящиеся к дополнительным эксплуатационным документам, если это необходимо.
Допускается приводить порядковые номера примечаний.
Текст примечаний может быть записан в конце соответствующих разделов ведомости эксплуатационных документов. Допускается текст примечаний записывать на последних листах ведомости эксплуатационных документов на формах без граф с проставлением порядкового номера примечаний.
В ведомости приводят также, при необходимости, перечень папок, в которые уложены документы, выполненные печатным способом.
Папки в ведомости записывают после перечисления всех документов под заголовком «Перечень папок» в графе «Наименование» в порядке возрастания их порядковых номеров.
При записи папок графы ведомости заполняют следующим образом:
- - графу «Обозначение» подчеркивают;
- - в графе «Наименование» указывают наименование и номер папки, например, «Папка № 1»;
- - в графе «Кол. экз.» указывают количество экземпляра папок данного наименования, входящих в состав одного комплекта эксплуатационных документов;
- - в графе «Местонахождение» указывают, при необходимости, местонахождение папок.
● Формуляр
Структуру и оформление формуляра устанавливают в соответствии с ГОСТ 19.105, ГОСТ 19.501.
Информационную часть (аннотацию и содержание) допускается в документ не включать.
В основную часть формуляра должны входить следующие разделы:
- - общие указания;
- - общие сведения;
- - основные характеристики;
- - комплектность;
- - периодический контроль основных характеристик при эксплуатации и хранении;
- - свидетельство о приёмке;
- - свидетельство об упаковке и маркировке;
- - гарантийные обязательства;
- - сведения о рекламациях;
- - сведения о хранении;
- - сведения о закреплении программного изделия при эксплуатации;
- - сведения об изменениях;
- - особые отметки;
- - приложения.
Состав и содержание разделов документа определяют в соответствии с особенностями программных изделий.
При необходимости допускается дополнять документ другими разделами или объединять отдельные разделы, а также помещать их в приложениях.
В разделе «Общие указания» приводят общие указания для обслуживающего персонала по эксплуатации программного изделия, заполнению и ведению его формуляра, например:
«Перед эксплуатацией необходимо внимательно ознакомиться с соответствующими эксплуатационными документами (приводятся наименования документов). Формуляр должен находиться в подразделении, ответственном за эксплуатацию программного изделия».
В разделе «Общие сведения» указывают наименование программного изделия, его обозначение, наименование организации-изготовителя, номер программного изделия и другие общие сведения о программном изделии.
В разделе «Основные характеристики» приводят необходимые при эксплуатации программного изделия значения основных характеристик (например, функциональных, надёжности и др.).
В разделе «Комплектность» перечисляют все непосредственно входящие в программное изделие другие программные изделия и документацию в соответствии с комплектностью, указанной в технических условиях на программное изделие.
При наличии ведомости эксплуатационных документов в формуляре делают на неё ссылку без перечисления эксплуатационных документов.
В разделе «Периодический контроль основных характеристик при эксплуатации и хранении» указывают наименование измерения проверяемых характеристик, требуемую периодичность контроля.
В разделе «Свидетельство о приёмке» приводят свидетельство о приёмке программного изделия, подписанное лицами, ответственными за приёмку.
В разделе «Свидетельство об упаковке и маркировке» помещают сведения об упаковке программного изделия, подписанные лицами, ответственными за упаковку.
В разделе «Гарантийные обязательства» приводят гарантийные обязательства организации-изготовителя.
В разделе «Сведения о рекламациях» приводят краткое изложение порядка предъявления рекламации и регистрируют все предъявленные рекламации, их содержание и принятые меры.
В разделе «Сведения о хранении» указывают сроки хранения программного изделия.
В разделе «Сведения о закреплении программного изделия при эксплуатации» указывают фамилии и должности лиц, за которыми закрепляют программное изделие.
В разделе «Сведения об изменениях» указывают основание для внесения изменений, содержание изменений с указанием его порядкового номера, а также должность, фамилию и подпись лица, ответственного за проведение изменения.
В разделе «Особые пометки» оставляют несколько чистых листов для специальных отметок, которые вносят во время эксплуатации программного изделия.
В качестве приложений к формуляру могут быть справочные материалы и дополнительные документы (например, журнал учёта работы), необходимые при эксплуатации программного изделия.
● Описание применения
Структуру и оформление описания применения устанавливают в соответствии с ГОСТ 19.105, ГОСТ 19.502.
Составление информационной части (аннотации и содержания) является обязательным.
Текст описания применения должен состоять из следующих разделов:
- - назначение программы;
- - условия применения;
- - описание задачи;
- - входные и выходные данные.
В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.
В разделе «Назначение программы» указывают назначение, возможности программы, её основные характеристики, ограничения, накладываемые на область применения программы.
В разделе «Условия применения» указываются условия, необходимые для выполнения программы (требования к необходимым для данной программы техническим средствам, и другим программам, общие характеристики входной и выходной информации, а также требования и условия организационного, технического и технологического характера и т.п.).
В разделе «Описание задачи» должны быть указаны определения задачи и методы ее решения.
В разделе «Входные и выходные данные» должны быть указаны сведения о входных и выходных данных.
В приложение к общему описанию могут быть включены справочные материалы (иллюстрации, таблицы, графики, примеры и т.п.).
● Руководство системного программиста
Структуру и оформление руководства системного программиста устанавливают в соответствии с ГОСТ 19.105, ГОСТ 19.503.
Составление информационной части (аннотации и содержания) является обязательным.
Руководство системного программиста должно содержать следующие разделы:
- - общие сведения о программе;
- - структура программы;
- - настройка программы;
- - проверка программы;
- - дополнительные возможности;
- - сообщения системному программисту.
В зависимости от особенностей документы допускается объединять отдельные разделы или вводить новые.
В обоснованных случаях допускается раздел «Дополнительные возможности» не приводить, а в наименованиях разделов опускать слово «программа» или заменять его на «наименование программы».
В разделе «Общие сведения о программе» должна быть указаны назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы.
В разделе «Структура программы» должны быть приведены сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.
В разделе «Настройка программы» должно быть приведено описание действий по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.). При необходимости приводят поясняющие примеры.
В разделе «Проверка программы» должны быть приведено описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).
В разделе «Дополнительные возможности» должно быть приведено описание дополнительных разделов функциональных возможностей программы и способов их выбора.
В разделе «Сообщения системному программисту» должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
В приложении к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).
● Руководство программиста
Структуру и оформление руководства программиста устанавливают в соответствии с ГОСТ 19.105, ГОСТ 19.504.
Составление информационной части (аннотации и содержания) является обязательным.
Руководство программиста должно содержать следующие разделы:
- - назначение и условия применения программ;
- - характеристика программы;
- - обращение к программе;
- - входные и выходные данные;
- - сообщения.
В зависимости от особенностей документы допускается объединять отдельные разделы или вводить новые.
В разделе «Назначение и условия применения программ» должны быть указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программного обеспечению и т.п.).
В разделе «Характеристика программы» должно быть приведено описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.).
В разделе «Обращение к программе» должно быть приведено описание процедур вызова программы (способы передачи управления и параметров данных и др.).
В разделе «Входные и выходные данные» должно быть приведено описание организации используемой входной и выходной информации и, при необходимости, ее кодирования.
В разделе «Сообщения» должны быть указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).
● Руководство оператора
Структуру и оформление руководства оператора устанавливают в соответствии с ГОСТ 19.105, ГОСТ 19.505.
Составление информационной части (аннотации и содержания) является обязательным.
Руководство оператора должно содержать следующие разделы:
- - назначение программы;
- - условия выполнения программы;
- - выполнение программы;
- - сообщения оператору.
В зависимости от особенностей документы допускается объединять отдельные разделы или вводить новые.
В разделе «Назначение программы» должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.
В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т.п.).
В разделе «Выполнение программы» должна быть указана последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, приведено описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузки и управляет выполнением программы, а также ответы программы на эти команды.
В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.).
Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.
В приложения к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства.
● Описание языка
Структуру и оформление описания языка устанавливают в соответствии с ГОСТ 19.105, ГОСТ 19.506.
Составление информационной части (аннотации и содержания) является обязательным.
Описание языка должно содержать следующие разделы:
- - общие сведения;
- - элементы языка.
Допускается вводить разделы:
- - способы структурирования программы;
- - средства обмена данными;
- - встроенные элементы;
- - средства отладки программы.
В зависимости от особенностей языка допускается объединять отдельные разделы или вводить новые.
В разделе «Общие сведения» должны быть указаны назначение и описание общих характеристик языка, его возможностей, основных областей применения и другие сведения.
В разделе «Элементы языка» должно быть указано описание синтаксиса и семантики базовых и составных элементов языка.
В разделе «Способы структурирования программы» должны быть указаны способы вызова процедур передачи управления и другие элементы структурирования программы.
В разделе «Средства обмена данными» должно быть приведено описание языковых средств обмена данными (например, средства ввода-вывода, внутреннего обмена данными и т. п.).
В разделе «Встроенные элементы» должны быть приведены описание встроенных в язык элементов (например, функции, классы и т. п.) и правила их использования.
В разделе «Средства отладки программы» должно быть приведено описание имеющихся в языке средств отладки программ, семантики этих средств, даны рекомендации по их применению.
При необходимости содержание разделов должно быть пояснено примерами.
В приложения к описанию языка могут быть включены дополнительные материалы (формализованные описания языковых средств, иллюстрации, таблицы, графики, формы бланков и т. п.).
● Руководство по техническому обслуживанию
Структуру и оформление руководства по техническому обслуживанию устанавливают в соответствии с ГОСТ 19.105, ГОСТ 19.508.
Составление информационной части (аннотации и содержания) является обязательным.
Руководство по техническому обслуживанию должно содержать следующие разделы:
- - введение;
- - общие указания;
- - требования к техническим средствам;
- - описание функций.
В зависимости от особенностей документа допускается вводить дополнительные разделы.
В разделе «Введение» указывают назначение руководства, перечень эксплуатационных документов, которыми должны дополнительно к руководству пользоваться при техническом обслуживании.
В разделе «Общие указания» указывают порядок технического обслуживания, приводят указание по организации и особенностям его проведения.
В разделе «Требования к техническим средствам» указывают минимальный состав технических средств, обеспечивающий работу программы.
В разделе «Описание функций» указывают:
- - максимальный состав технических средств, проверяемых этой программой;
- - описание совместного функционирования технических средств и программы с указанием метода обработки ошибок;
- - описание организации входных и выходных данных, используемых при обслуживании технических средств;
- - описание взаимодействий устройств с программой, результатов взаимодействий, с выводом результатов работы программы.
● Программа и методика испытаний
Структуру и оформление программы и методики испытаний устанавливают в соответствии с ГОСТ 19.105, ГОСТ 19.301.
Составление информационной части (аннотации и содержания) не является обязательным.
Программа и методика испытаний должны содержать следующие разделы:
- - объект испытаний;
- - цель испытаний;
- - требования к программе;
- - требования к программной документации;
- - средства и порядок испытаний;
- - методы испытаний.
В зависимости от особенностей документа допускается вводить дополнительные разделы.
В разделе «Объект испытаний» указывают наименование, область применения и обозначение испытуемой программы.
В разделе «Цель испытаний» должна быть указана цель проведения испытаний.
В разделе «Требования к программе» должны быть указаны требования, подлежащие проверке во время испытаний и заданные в техническом задании на программу.
В разделе «Требования к программной документации» должны быть указаны состав программной документации, предъявляемой на испытания, а также специальные требования, если они заданы в техническом задании на программу.
В разделе «Средства и порядок испытаний» должны быть указаны технические и программные средства, используемые во время испытаний, а также порядок проведения испытаний.
В разделе «Методы испытаний» должны быть приведены описания используемых методов испытаний. Методы испытаний рекомендуется по отдельным показателям располагать в последовательности, в которой эти показатели расположены в разделах «Требования к программе» и «Требования к программной документации».
В методах испытаний должны быть приведены описания проверок с указанием результатов проведения испытаний (перечней тестовых примеров, контрольных распечаток тестовых примеров и т.п.).
В приложение к документу могут быть включены тестовые примеры, контрольные распечатки тестовых примеров, таблицы, графики и т.п.
Испытания программы
Испытания программы производятся в соответствии с программой и методикой испытаний.
Перечень и формы документов, оформляемых по результатам испытаний, устанавливаются в ТЗ.
Испытания программной продукции, предназначенной для использования в органах автоматизации органов управления Министерства обороны Российской Федерации производятся в соответствии с требованиями ГОСТ РВ 51719.
По результатам испытаний производится корректировка программы и программной документации (при необходимости).
На основании проведенных испытаний, после корректировка программ и программной документации, производится подготовка и передача программы и программной документации для сопровождения и (или) изготовления (согласно ТЗ).
Передача программы на сопровождение и (или) изготовление производится на основании акта. Форма акта устанавливается в ТЗ.
При необходимости может производиться передача программы в фонд алгоритмов и программ. Ответственный за оформление документации для передачи – начальник КО.
Учет и распределение программной документации
Все имеющиеся в организации подлинники, дубликаты и копии программных документов, кроме документа «Техническое задание», подлежат учету и хранению в бюро технической документации (БТД).
Выполнение необходимого количества копий программных документов и выдачу их подразделениям осуществляет БТД.
Учет ПД, выполненной в электронной форме, ведется в соответствии с требованиями ГОСТ 2.501 с учетом СТО ….
Остальные требования по учету программной документации – по ГОСТ 19.602.
Ответственность за правильность учета программной документации возложена на начальника БТД.
Распределение ПД осуществляется согласно СТО по управлению КД применительно к программной документации.
Внедрение программной документации
Внедрению подлежит программная документация, разработанная ООО «ООО», а также программная документация, поступившая от внешних организаций.
Если введение в действие программного документа требует проведения каких-либо организационных и (или) технических мероприятий, то проводится подготовка производства с учетом применимых для ситуации положений СТО ….
Внесение изменений в программную документацию
Порядок оформления и внесения изменений в ПД установлен СТО ...
Любое изменение программного документа, вызывающее какие-либо изменения в других программных документах, должно сопровождаться одновременным выпуском извещений о внесении соответствующих изменений во все взаимосвязанные документы.
ВНИМАНИЕ! О внесении изменений в КД, ПД и ТД канал «СМК-консультант» писал ЗДЕСЬ.
Хранение и изъятие из обращения
Хранение подлинников ПД производится работниками БТД в соответствии с требованиями ГОСТ 19.602.
Подлинники, принимаемые на хранение, должны соответствовать общим требованиям к программным документам и стандартам ЕСПД на программные документы, выполненные на различных носителях данных.
При приеме подлинников БТД проверяет: комплектность подлинников в соответствии со спецификацией; пригодность к хранению и многократному снятию дубликатов, копий; наличие установленных подписей и дат.
Подлинники, принятые на хранение, регистрируются в инвентарной книге подлинников по форме 1 приложения Б ГОСТ 2.501. При этом в графе «Примечание» должны указываться виды носителей данных, на которых представлены подлинники.
Одновременно с регистрацией подлинников в инвентарной книге проставляют и (или) заполняют штамп для учета по ГОСТ 2.104.
Подлиннику присваивают один инвентарный номер.
На каждый подлинник, которому присвоен инвентарный номер, составляют карточку учета в соответствии с формой 2 приложения Б ГОСТ 2.501. При этом в графе «Обозначение» указывают вид носителя данных, а в левом нижнем углу вносят надпись «Программный документ».
Подлинники программных документов хранят в БТД в порядке возрастания обозначений или обозначений по каждому различительному индексу.
Условия хранения подлинников ПД должны обеспечивать ее сохранность, учет, рациональное размещение, удобство для работы с ней, а также исключать свободный доступ посторонних лиц, возможность утраты, перепутывания или порчи документов.
Хранение ПД в электронной форме осуществляется в соответствии с требованиями ГОСТ 2.501, ГОСТ Р 54989.
Хранение документов в электронном виде производится на зарегистрированном и не допускающем изменения носителе (CD-R, DVD-R).
Регистрация носителей производится путем нанесения регистрационного номера по журналу на носитель специальным маркером.
График переноса ПД на внешние носители устанавливается начальником бюро информационных технологий (БИТ) по согласованию с начальниками КО и БТД.
Целью изъятия из обращения ПД является исключение возможности использования в производственном процессе недействующей ПД.
Изъятию подлежит отмененная или замененная в установленном порядке ПД, а также документация, подвергшаяся физическому износу.
После получения извещения об аннулировании или замене ПД все подразделения, имеющие указанный документ, обязаны все его экземпляры сдать в БТД.
Выдача подразделениям вновь введенной ПД допускается только после изъятия отмененной.
Подлинники (оригиналы), дубликаты и копии отмененных и замененных ПД подлежат уничтожению по СТО ….
При этом в инвентарных журналах учета делается соответствующая отметка. Допускается хранить в архиве КО один экземпляр идентифицированной как отмененной (замененной) ПД для справочных или юридических целей, а также в целях сохранения необходимой информации.
При управлении ПД могут быть определены следующие риски:
- - риск изготовления несоответствующей продукции из-за несвоевременно внесенных изменений в ПД;
- - риск утраты подлинников ПД в электронном виде;
- - риск приведения подлинников ПД в ненадлежащее состояние из-за нарушений в их хранении.
Критериями оценки процедуры управления ПД могут быть:
- - отсутствие случаев выпуска несоответствующей продукции из-за ненадлежащего управления ПД;
- - отсутствие случаев утраты подлинников ПД.
Посмотреть содержание стандартов организации по управлению ПД можно:
- для военной продукции ЗДЕСЬ – СТО 123456RW-145-2021 Управление документированной информацией. Программная документация;
- для гражданской продукции ЗДЕСЬ – СТО 8765RISO-145-2022 Управление документированной информацией. Программная документация.
Актуальный перечень ранее опубликованных на канале статей (261 шт) со ссылками можно посмотреть/скачать ЗДЕСЬ.
11.10.2023