Богданов - Стандартизация жизненного цикла и качества программных средств - 2000

в) они выступают, как контрольные пункты, которые позволяют руководителям оценивать ход разработки (если документы разработки отсутствуют, неполны или устарели, то руководители проекта теряют важное средство для отслеживания и контроля проекта);

г) они образуют основу документации сопровождения ПС, требуемой лицам, сопровождающим ПС, как часть документации продукции;

д) они описывают историю разработки ПС. Типовыми документами разработки являются:

–анализы осуществимости и исходные заявки;

–спецификации требований и функций;

–проектные спецификации, включая спецификации программ и данных;

–планы разработки, сборки и тестирования ПС;

–планы обеспечения качества, стандарты и графики;

–защитная и текстовая информация.

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

Документация продукции преследует три цели:

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

–облегчение сопровождения и модернизации ПС программистам, не разрабатывавших ПС;

–помощь при продаже или приемке ПС.

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

Типовые документы продукции включают в себя:

–учебные руководства;

–справочные руководства и руководства пользователя;

–руководства по сопровождению ПС;

–брошюры и информационные листки, посвященные продукции. ГОСТ Р ИСО 9127-94 вводит определение документации пользо-

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

111

Данный стандарт определяет три категории информации:

–обязательная – информация, поставляемая с каждым пакетом;

–условная – информация, поставляемая с каждым пакетом, для которого она необходима;

–факультативная – информация, поставляемая с каждым пакетом, по усмотрению изготовителя или торгующей организации.

Назначением документации пользователя является обеспечение конечного пользователя достаточной информацией для ясного понимания:

–цели, функций и характеристик ПС;

–того, как ввести в действие и использовать ПС;

–договорных прав и обязанностей.

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

Таким образом, ГОСТ Р ИСО 9127-94, не имея формальных ссылок на ГОСТ Р ИСО/МЭК ТО 9294-93, фактически дополняет введенное в нем понятие документации продукции.

Документация управления проектом. Документы создаются на основе информации управления проектом, такой как:

–графики для каждой стадии процесса разработки и отчеты об изменениях графиков;

–отчеты о согласованных изменениях ПС;

–отчеты о решениях, связанных с разработкой;

–распределение обязанностей.

Данная документация обеспечивает информацию, относящуюся, с точки зрения руководства, к долговечности продукции.

Определение качества документов. Руководители должны выбирать стандарты, распространяющиеся на уровень качества, соответственно различным типам документов и различным типам проектов и должны определять, как это качество будет достигнуто и поддержано.

Понятия качества, применимые к содержанию, структуре и представлению документации:

–качество содержания можно измерять в элементах точности, полноты и ясности;

–качество структуры, можно измерять легкостью, с которой чи- татель имеет возможность определить местоположение информации;

112

– качество представления должно соответствовать типу проекта.

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

Информация может быть представлена в различных форматах, причем форматы могут меняться от проекта к проекту. Форматы зависят от таких факторов, как объем проекта, аудитория, для которой предназначены документы, количество стадий разработки и бюджет документирования. Кроме того, должно быть учтено соображение о том, будут ли документы переводить для международного распространения.

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

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

Если документы выпускаются в виде разрозненных листов, каждая страница должна иметь индивидуальное обозначение (например, со ссылочным номером документа, номером страницы и номером издания).

3.2. Требования стандартов к программной документации

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

Единая система программной документации (ЕСПД) устанавливает следующие виды программной документации.

1.Спецификация. Состав программы и документация на нее.

2.Ведомость держателей подлинников. Перечень предприятий, на которых хранят подлинники программных документов.

3.Текст программы. Запись программы с необходимыми комментариями.

4.Описание программы. Сведения о логической структуре и функционировании программ.

113

5.Программа и методика испытаний. Требования, подлежащие проверке при испытании программы, а также порядок и методы контроля.

6.Техническое задание. Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний.

7.Пояснительная записка. Схема алгоритма, общее описание алгоритма и функционирования программы, а также обоснование принятых технических и технико-экономических решений.

8.Эксплуатационные документы. Сведения для обеспечения функционирования и эксплуатации программы. Перечень эксплуатационных документов представлен в табл. 3.1.

Таблица 3.1

114

Полный пакет документов, разрабатываемых при создание автоматизированной системы и, в частности, программного обеспече- ния, установленный в отечественных стандартах, включает:

ГОСТ 34.602-89 – техническое задание на создание АС; ГОСТ 34.201-90 – виды и комплектность документов;

РД 50-34.698-90 – пояснительная записка, схема функциональной структуры, общее описание системы, описание постановки зада- чи, описание информационного обеспечения системы, описание организации информационной базы, перечень входных сигналов и данных, перечень выходных сигналов/документов, описание программного обеспечения;

ГОСТ 19.201-78 – техническое задание; ГОСТ 19.402-78 – описание программы; ГОСТ 19.404-79 – пояснительная записка;

ГОСТ 19.301-79 – программа и методика испытаний. Техническое задание. Содержание технического задания на раз-

работку программных продуктов должно соответствовать ГОСТ 19.201-78 “Техническое задание. Требования к содержанию и оформлению”. Помимо разработки технического задания на все ПС могут разрабатываться технические задания на этапы, например, техническое задание на выполнение НИР.

Согласно ГОСТ 19.201-78, техническое задание на разработку ПС должно включать следующие разделы:

–введение;

–основания для разработки;

–назначение разработки;

–требования к программе;

–требования к программной документации;

–технико-экономические показатели;

–стадии и этапы разработки;

–порядок контроля и приемки;

–приложения.

Âзависимости от особенностей разрабатываемого ПС стандарт допускает уточнение содержания разделов, введение новых разделов или их объединение.

Âразделе “Введение” указывается наименование, краткая характеристика области применения ПС.

Âразделе “Основания для разработки” указываются:

–документ (документы), на основание которых ведется разработка;

–организация, утвердившая документ, и дата утверждения;

–наименование (условное обозначение) темы разработки.

115

Âразделе “Назначение разработки” должно быть указано функциональное и эксплуатационное назначение ПС.

Âраздел “Требования к программе” включаются следующие подразделы.

1. Требования к функциональным характеристикам, в которых указываются требования к составу выполняемых функций, организации входных и выходных данных, временным характеристикам.

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

2. Требования к надежности, где указываются требования к обеспе- чению надежного функционирования ПС, его защите (контроль входной и выходной информации, описание последствий отказов ПС и т.д.).

3. Условия эксплуатации, в которых должны быть указаны характеристики операционной среды, вид обслуживания, необходимое количество и квалификация персонала и др., а также допустимые параметры окружающей среды (относительная влажность, температура и др.).

4. Требования к составу и параметрам технических средств – необходимый состав технических средств (конфигурация) с указанием их основных технических характеристик.

5. Требования к информационной и программной совместимости, в которых указываются требования к информационным структурам на входе и выходе и методам решения, исходным кодам, языкам программирования и программным средствам, используемым ПС. Кроме того, могут указываться протоколы межмашинного сетевого обмена данными, стандарты протоколов формализации данных и управления терминалами, стандарты и форматы сообщений, протоколы транзакций, протоколы запросов данных, стандарты представления данных, требования к СУБД и операционным системам.

6. Требования к маркировке и упаковке.

7. Требования к транспортированию и хранению.

Âразделе “Требования к программной документации” должен быть указан предварительный состав программной документации и при необходимости специальные требования к ней.

Âразделе “Технико-экономические показатели” указываются: ориентировочная экономическая эффективность, предполагаемая годовая потребность, экономические преимущества разработки по

116

сравнению с лучшими отечественными и зарубежными образцами или аналогами.

Âразделе “Стадии и этапы разработки” устанавливают необходимые стадии разработки, этапы и содержание работ (перечень документов, которые должны быть разработаны, согласованы и утверждены), а также сроки разработки и исполнителей.

Âразделе “Порядок контроля и приемки” должны быть указаны виды испытаний и общие требования к приемке ПС. Здесь фиксируют важнейшие характеристики ПС в некоторой количественной или иной достаточно простой форме, с тем, чтобы можно было установить степень соответствия готового ПС принятым техническим условиям.

Âприложениях к техническому заданию при необходимости приводят:

– перечень научно-исследовательских и других работ, обосновывающих разработку;

– схемы алгоритмов, таблицы, описания, обоснования, расчеты

èдругие документы, которые могут быть использованы при разработке;

– другие источники разработки.

Техническое задание на создание АС разрабатывается в соответствии с ГОСТ 34.602-89. Данный стандарт устанавливает следующие разделы, включаемые в техническое задание.

1. Общие сведения, включающие полное наименование системы, условное обозначение системы, шифр темы (шифр (номер) договора), наименование предприятий разработчика и заказчика системы

èих реквизиты, перечень документов, на основании которых создается система, плановые сроки начала и окончания работ по созданию АС, сведения об источниках и порядке финансирования работ.

2. Назначение и цели создания АС, в котором указывают назна- чение системы и цели ее создания.

3. Характеристика объекта автоматизации.

4. Требования к системе. Данный раздел состоит из следующих подразделов:

а) Требования к системе в целом. Здесь указывают перечень подсистем, их назначение и основные характеристики, требования к числу уровней иерархии и степени централизации системы, требования к способам и средствам связи для информационного обмена между компонентами системы, требования к характеристикам взаимосвязей АС со смежными системами, требования к ее совместимости, способы обмена информации. Кроме того, требования к численности

117

и квалификации персонала и режиму его работы, к надежности, безопасности и т.д..

б) Требования к функциям.

в) Требования к видам обеспечения (математическому, информационному, лингвистическому программному, техническому организационному и т. д.).

5.Состав и содержание работ по созданию (развитию) АС.

6.Порядок контроля и приемки системы.

7.Требования к составу и содержанию работ по подготовке объекта автоматизации к вводу в действие.

8.Требования к документированию.

9.Источники разработки.

Основное внимание следует уделить руководящему документу РД 50-34.698-90, устанавливающему требования к содержанию документов на автоматизированные системы. Структура РД 50-34.698- 90 приведена в табл. 3.2.

Содержание документов, разрабатываемых на предпроектных стадиях (“Формирование требований к АС” и “Разработка концепции АС”), приведено в рекомендуемом приложении к РД 50-34.698-90. На первой стадии разрабатывается отчет (ГОСТ 7.32) и заявка на разработку АС. На второй – отчет согласно ГОСТ 7.32.

Содержание организационно-распорядительных документов установлено также в рекомендуемом приложении. К организационнораспорядительным документам относятся:

–акт завершения работы;

–акты приемки в опытную и промышленную эксплуатацию;

–план-график работ;

–приказы о проведении работ и составе приемочной комиссии;

–протоколы испытаний и согласования.

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

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

Âразделе “Структура ПО” приводят перечень частей ПО с указанием их взаимосвязей и обоснованием выделения каждой из них. В разделе “Функции частей ПО” приводят назначение и описание основных функций для каждой части ПО.

Âразделе “Методы и средства разработки ПО” приводят пере- чень методов программирования и средства разработки ПО АС с

118

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

В разделе “Операционная система” указывают следующее.

1.Наименование, обозначение и краткую характеристику выбранной операционной системы и ее версии, в рамках которой будут выполнять разрабатываемые программы, с обоснованием выбора и указанием источников, где дано подробное описание выбранной версии.

2.Наименование руководства, в соответствии с которым должна осуществляться генерация выбранного варианта операционной системы.

3.Требования к варианту генерации выбранной версии ОС. Раздел “Средства, расширяющие возможности операционной сис-

темы (ОС)” содержит подразделы, в которых для каждого используемого средства, расширяющего возможности операционной системы, указывают:

–наименование, обозначение и краткую характеристику средства с обоснованием необходимости его применения и указанием источников, где дано подробное описание выбранного средства;

–наименование руководства, в соответствии с которым следует настраивать используемое средство на конкретное применение;

–требования к настройке используемого средства.

119

120