3.5.1. Документы по программному обеспечению.
Документация программного обеспечения включает:
описание программного обеспечения;
пояснительная записка;
общее описание;
описание программы;
спецификация;
руководство программиста;
текст программы (в определенных случаях);
формуляр;
порядок и методика испытаний;
описание контрольного примера.
Описание программного обеспечения АИС должно содержать: вводную часть; структуру программного обеспечения; основные функции частей программного обеспечения; методы и средства разработки программного обеспечения; операционную систему; средства расширяющие возможности операционной системы.
Раздел «Вводная часть» должен содержать основные сведения о техническом, информационном и других видах обеспечения АИС, необходимые для разработки программного обеспечения, или ссылку на соответствующие документы проекта АИС.
Раздел «Структура программного обеспечения» должен содержать перечень частей программного обеспечения с указанием взаимосвязей и обоснованием выделения каждой из них.
Раздел «Основные функции частей программного обеспечения» должен содержать подразделы, в которых для каждой части программного обеспечения приводят назначение и описание основных функций, а также состав проектных документов, подлежащих разработке,
Раздел «Методы и средства разработки программного обеспечения» должен содержать перечень методов программирования и средств разработки программного обеспечения с указанием частей программного обеспечения, при разработке которых следует использовать соответствующие методы и средства.
Раздел «Операционная система» должен содержать: наименование, обозначение и краткую характеристику выбранной операционной системы и ее версии, в рамках которой будут выполняться разрабатываемые программы, с обоснованием выбора и указанием источников, где дано подробное описание выбранной версии; наименование руководства, в соответствии с которым должна осуществляться генерация выбранного варианта операционной системы; требования к варианту генерации выбранной версии операционной системы.
Раздел «Средства, расширяющие возможности операционной системы» должен содержать подразделы, в которых для каждого используемого средства, расширяющего возможности операционной системы, следует указать: наименование, обозначение и краткую характеристику средства с обоснованием необходимости его применения и указанием источника, где дано подробное описание выбранного средства; наименование руководства, в соответствии с которым следует настраивать используемое средство на конкретное использование; требования к настройке используемого средства.
Описание программы должно соответствовать ГОСТ. Для программы, получаемой за счет использования ранее разработанных программных средств, документ «Описание программ» дополняется разделом «Настройка программных средств».
Руководство программиста по составу разделов и их содержанию должно соответствовать ГОСТ и, кроме того, включать раздел «Сведения о форме представления программы».
Раздел «Сведения о форме представления программы» должен содержать сведения о носителе, на котором записана программа, о содержании и системе кодирования информации, записанной на носителе, а также сведения, необходимые для чтения информации с носителя.
Описание контрольного примера должно содержать разделы: назначение; исходные данные; результаты расчета; проверка программы.
Раздел «Назначение» должен содержать перечень параметров и краткую характеристику функций, из числа реализуемых программой, проверяемых контрольным примером.
Раздел «Исходные данные» должен содержать описание исходных данных для проверки программы и сами исходные данные.
Раздел «Результаты расчета» должен содержать результаты обработки исходных данных программой, позволяющие оценить правильность выполнения проверяемых функций и значений проверяемых параметров.
Раздел «Проверка программы» должен содержать: описание состава технических средств, необходимых для работы программы, или ссылку на соответствующие программные документы; описание процедур формирования исходных данных для проверки программы, вызова проверяемой программы и получения результатов ее работы; описание действий оператора при подготовке исходных данных и проверке программы на контрольном примере.