Структура и содержание документации на программные средства
Предложения по профилю стандартов на разработку программных средств содержат структуру технологических и эксплуатационных документов, которые необходимы на этапах создания, применения и сопровождения ИС. Выполнение процесса ЖЦ ИС считается законченным, если выполнены требуемые задачи и оформлены все документы в соответствии с заранее установленными требованиями.
Под технологической документацией понимают подробные технические описания для специалистов, ведущих проектирование, разработку и сопровождение ИС.
Эксплуатационная документация создается для конечных пользователей ИС, чтобы они могли освоить и квалифицированно применять эти средства при эксплуатации и сопровождении системы.
Каждый разрабатываемый документ должен позволять контролировать результаты и качество выполненных работ. В общем случае каждый документ должен иметь:
- наименование;
- назначение;
- категории пользователей, для которых он разрабатывается;
- авторов разработки;
- этапы работ, на которых его надо применять;
- функциональную, содержательную часть в соответствии с его назначением.
Далее предполагается набор рекомендуемой технологической и эксплуатационной документации (номера документов соответствуют номерам работ в табл. 3 профиля стандартов).
Документ 1.1. Обследование объекта информатизации и формирование требований к ИС:
- описание результатов изучения объекта информатизации;
|
|
|
- цели и ограничения создания ИС;
- функции и задачи создаваемого ИС;
- ожидаемые технико-экономические результаты создания ИС;
- рекомендации по созданию ИС, БД, интерфейсов пользователей, выбору СУБД;
- условия испытания и приемки ИС;
- характеристики комплекса задач;
- входная информация (формы представления, сроки и частота поступления, источники информации);
- выходная информация (описание выходных сообщений, периодичность выдачи, допустимое время задержки, получатели и назначение выходной информации);
- ожидаемые технико-экономические результаты создания системы (перечень основных источников экономической эффективности, получаемых в результате создания системы, и оценка ожидаемых изменений основных технико-экономических и социальных показателей деятельности объекта; оценка ожидаемых затрат на создание и эксплуатацию системы с распределением их по очередям создания системы и по годам; ожидаемые обобщающие показатели экономической эффективности системы);
- выводы и предложения о производственно-хозяйственной необходимости и технико-экономической целесообразности создания системы, о совершенствовании организации и технологии процесса деятельности;
|
|
|
- рекомендации по созданию системы;
- первичный набор профиля стандартов.
Документ 1.2. Техническое задание на проектирование ИС
Этот документ предполагает поэтапное уточнение и детализацию предлагаемых ниже разделов, подробно описанных в ГОСТ 43.602-89:
- титульный лист с утверждающими и согласующими подписями;
- назначение и цель разработки ИС;
- общие сроки выполнения проекта;
- общие технические требования и базовые нормативные документы для выполнения ИС;
- общие требования к ИС;
- специальные требования к аппаратной и операционной платформам;
- требования к оформлению и содержанию эксплуатационной и технологической документации;
- требования к составу и содержанию работ по внедрению ИС в эксплуатацию;
- этапы и сроки выполнения основных работ;
- ожидаемые результаты и формы их представления;
- порядок контроля и приемки результатов работы.
Документ 2.1. Руководство администратора:
- функции администрирования при применении данного ИС;
- процедуры по инсталляции и подготовке ИС к эксплуатации;
- способы и формы контроля исполнения заданий;
- настройка ИС.
Документ 2.2. Руководство оператора:
|
|
|
- введение (область применения, требования к уровню подготовки пользователей, перечень эксплуатационной документации, с которым необходимо ознакомиться пользователю);
- назначение и условия применения;
- подготовка к работе;
- описание операций обработки данных;
- аварийные ситуации и действия оператора при их наступлении;
- контрольный пример, правила его запуска и выполнения.
Документ 2.3. Документация на разработанный модуль ИС (руководство программиста):
- ТЗ и/или спецификация требований на разработку программы;
- описание программы (краткое описание задачи, алгоритма, структуры и функций модуля, пользовательского интерфейса, входных и выходных компонент, межмодульных интерфейсов, описание способов проверки работоспособности и контрольные примеры);
- исходный текст программы на бумажном носителе;
- исходный текст и объектный код программы на магнитных или иных носителях.
Документ 2.4. Пояснительная записка к эскизному и техническому проектам ПС:
- общие положения;
- основные технические решения (по структуре и функциям ИС, режимам функционирования, составу комплексов задач и интерфейсов, назначение и характеристики программных модулей и таблиц БД, функциям СУБД, по структуре технических средств, по организационной структуре, по языкам программирования, по организации и ведению базы данных и т.п.);
|
|
|
- мероприятия по подготовке объекта информатизации к вводу ИС в действие;
- перечень всех технологических и эксплуатационных документов.
Документ 3.1. Утвержденные спецификации требований и алгоритмы на функциональные группы программ, программные и информационные компоненты:
- назначение и характеристики алгоритма (постановка задачи, краткие сведения о процессе (объекте), ограничения на возможность и условия применения, характеристики качества решения, общие требования к входным и выходным данным);
- используемая информация и их характеристика;
- результаты решения;
- математическое описание;
- требования к разработке программ.
Документ 4.1. Отчеты о результатах тестирования:
- журнал тестирования;
- отчет об аномальных событиях;
- итоговый отчет.
Документ 5.1. Программа испытаний:
- объект испытаний;
- цель испытаний;
- собственно программа испытаний;
- методики испытаний.
Документ 5.2. Методики испытаний:
- объект испытаний;
- цель испытаний;
- общие положения методов испытаний;
- объем испытаний по разделам программы;
- условия и порядок проведения испытаний;
- материально-техническое обеспечение;
- отчетность и документирование результатов испытаний;
- акт и итоговый отчет о результатах испытаний.
Документ 5.3. Протокол испытаний:
- наименование объекта испытаний;
- список должностных лиц, проводивших испытания;
- цель испытания;
- назначение тестирования и разделы ТЗ, по которому проводились испытания;
- перечень пунктов программы испытаний и указание соответствующих методик, обработка и оценка результатов;
- условия проведения тестирования и характеристики исходных данных;
- сведения об отказах, аварийных ситуациях;
- сведения о корректировках параметров объекта испытаний и технической документации;
- обобщенные результаты испытаний с оценкой их на соответствие ТЗ и технической документации;
- выводы о результатах испытаний и соответствии созданной ИС требованиям ТЗ.
Документ 5.4. Акт завершения работ:
- наименование завершенной работы;
- список представителей заказчика и разработчика, составивших акт;
- дата завершения работ;
- наименование документа, на основании которого проводилась работа;
- основные результаты завершенной работы;
- заключение о результатах завершенной работы.
Документ 6.1. Акт приемки ИС в промышленную эксплуатацию:
- наименование ИС, принимаемой в эксплуатацию;
- сведения о статусе приемочной комиссии;
- период времени работы комиссии;
- состав функций ИС, принимаемых в эксплуатацию;
- перечень документов, предъявляемых комиссии;
- заключение о результатах опытной эксплуатации ИС;
- оценка соответствия принимаемой ИС техническому заданию на ее создание;
- краткая характеристика работ по созданию ИС и основные результаты;
- оценка экономической эффективности от внедрения ИС;
- решение комиссии;
- рекомендации комиссии по дальнейшему развитию ИС.
К акту прилагаются:
- программа и протокол испытаний;
- протоколы заседания комиссий;
- перечень технических средств, которые использовала комиссия при приемке ИС.
Документ 6.2. Акт о завершении приемо-сдаточных испытаний и результаты выполнения контракта на разработку ИС:
- наименование завершенной работы;
- список представителей заказчика и разработчика, составивших акт;
- дата завершения работ;
- наименование документа, на основании которого проводилась работа;
- основные результаты завершенной работы;
- заключение о выполнении контракта.
Документ 7.1. Отчеты пользователей о выявленных дефектах и предложениях по корректировке версий ИС:
- идентификатор пользователя;
- номер пользовательской деятельности;
- подробное описание сценария и исходных данных, при которых выявлен дефект;
- предположение о причине появления дефекта;
- предложения по модификации ИС или совершенствование функционирования программы.
Документ 7.2. Журнал выявленных дефектов и предложений по совершенствованию версий ИС:
- идентификатор разработчика, которому отдан отчет пользователя для анализа;
- тесты, исходные данные и сценарий, при которых проявляется дефект;
- результаты анализа причины и источника выявленного дефекта;
- предложения по устранению дефекта;
- оценка сложности, трудоемкости и срочности модификации программ и БД;
- оценки влияния предлагаемых изменений на эксплуатацию версий ПС, имеющихся у пользователей.
Документ 7.3. Журнал подготовленных и утвержденных корректировок:
- идентификатор специалиста, разработавшего модификацию программы и БД;
- дата разработки модификации;
- причина изменения программ и БД;
- содержание изменений программ, БД и документации;
- результаты тестирования;
- результаты испытаний;
- решение по распространению версии среди пользователей;
- адрес хранения корректировок, документов и тестов новой версии ИС.
Документ 7.4. Извещение пользователей о выпуске новой версии ИС или о прекращении сопровождения определенной версии ИС:
- краткое обоснование причин модификации или прекращения сопровождения версии ИС;
- описание содержания основных изменений в новой версии;
- рекомендации по приобретению или замене пользовательской версии ИС.
Дата добавления: 2019-07-17; просмотров: 490; Мы поможем в написании вашей работы! |
Мы поможем в написании ваших работ!