ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ВСТРОЕННЫХ СИСТЕМ. Общие требования к разработке и документированию

Данное руководство содержит описание аппаратных и программных средств, требуемых для работы системы:

— технические характеристики используемых устройств;

— структура ПО, обзор назначения/функционирования каждого компонента ПО;

— перечень входных команд, команд доступа к ПО и реакция на их выполнение;

— аварийные сообщения и другие выходные данные, формируемые ПО;

— типовые времена выполнения;

— последовательность действий для запуска;

— перечень требуемых библиотек поддержки, интерфейсов;

— форма и средства регистрации ошибок, возникающих в процессе эксплуатации ПО;

— перечень процедур, выполняемых оператором при установке ПО для конкретного выбранного окружения, конкретной конфигурации ПО.

Руководство по входной/выходной информации ПО объясняет пользователю как представить, ввести входную информацию и как интерпретировать выходную информацию, в каком режиме (пакетном или интерактивном) работает система ПО, запускаемая непосредственно с центрального компьютера или другим централизованным способом, или через сеть.

Данное руководство содержит краткое описание прикладного ПО, перечень файлов, включая базу данных и файлы со справочной информацией для пользователя, описание аппаратуры, ПО и прочих ресурсов, необходимых для доступа к данному прикладному ПО и использования этого ПО в полном объеме, включая:

— режимы работы;

— описание процедур, позволяющих получить помощь при возникновении ошибочных ситуаций при работе с прикладным ПО;

— терминалы, принтеры и другие входные/выходные устройства;

— необходимые процедуры, утилиты, в том числе процедуры для установки ПО;

— форматы представления входной/выходной информации, их тип, объем;

— точность представления, скорость передачи, ожидаемое время реакции;

— способ задания конца информации и другие требуемые соглашения;

— ограничения и наиболее типичные ошибки задания информации;

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

Руководство пользователя ПО описывает порядок действий пользователя ПО для установки и использования ЭКПО, группы ЭКПО или системы/подсистемы ПО.

Руководство разрабатывают для ПО, которое прогоняется самим пользователем, и для используемого им интерфейса, требуемого для введения входных данных и интерпретации получаемых выходных результатов. При наличии в системе встроенного ПО не требуется отдельного руководства для пользователя, перечень требуемых процедур для работы с таким ПО можно включить в данный документ. Содержание руководства:

— краткое описание характеристик ПО;

— перечень файлов, включая файлы базы данных, необходимых для работы ПО;

— порядок действий для продолжения или возобновления работы в случаях возникновения непредвиденных ситуаций;

— описание программной среды;

— организация ПО и функционирование ПО с точки зрения пользователя;

— описание процедур, позволяющих фиксировать ошибки;

— детальные, пошаговые действия пользователя при включении системы и дальнейшей работе с ней;

— ссылки на другие переданные руководства;

— перечень и пояснение выводимых системой сообщений.

Документ «Описание версии ПО» является полным описанием версии ПО, которая предназначена для передачи пользователю. Данный документ должен содержать следующую информацию:

— полную идентификацию системы и ПО, к которым применяют данный документ, включая регистрационные номера управления конфигурацией и номера версий;

— краткий обзор назначения системы и ПО, историю разработки, эксплуатации и сопровождения системы, идентификацию заказчика, пользователя, разработчика, организации, осуществляющей поддержку, текущих и планируемых мест установки системы;

— полную идентификацию физических носителей, содержащих ПО и связанные с ними документы;

— полную идентификацию всех компьютерных файлов, содержащих ПО;

— перечень всех изменений, внесенных после выпуска предыдущей версии в ПО;

— перечень документов ПО, связанных с данной версией;

— инструкцию по установке ПО;

— перечень возможных проблем и известных ошибок.

В этом разделе представлены дополнительные аспекты сертификации ПО в случаях использования ранее разработанного ПО и аттестации инструментальных средств ПО.