ЧЕЛОВЕЧЕСКИЙ ФАКТОР

Содержание инструкций и руководств

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

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

2. Предисловие, введение или аннотация. Здесь дается крат­кая характеристика документа и его содержания. Указывается предполагаемый круг пользователей, приводится краткое описа­ние каждой инструкции общего характера или сообщаются не­обходимые меры предосторожности при пользовании ею.

3. Оглавление. Включает названия тематических заголовков и номера соответствующих страниц; структурирует текст по главам, частям, разделам и подразделам.

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

5. Главы или основные разделы. Это основная часть доку­ментации, в которой для большего удобства целесообразно раз­граничивать разделы специальными метками или жесткими вкладками.

6. Резюме. Краткая характеристика ключевых понятий, по­могающих читателю запомнить прочитанное. Резюме может за­вершать каждую главу или каждую часть, объединяющую не­сколько глав.

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

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

9. Контрольные вопросы по главам, контрольные задачи или упражнения. Дополнительный материал, предназначенный для иллюстрирования способов использования изложенных принци­пов в разных ситуациях и вырабатывания у пользователя необ­ходимых практических навыков. Полезно предусмотреть «обрат­ную сзязь» для тех лиц, которые пользуются фрагментами до­
кументации как учебным материалом; в этом случае недоста­точно усвоенный материал может быть закреплен повторно до перехода к изучению нового.

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

11. Приложения. Содержат материалы, слишком объемные для включения в основной текст, детализирующие изложение или имеющие второстепенное значение (по отношению к основ­ному тексту).

Подгото­вительная Фаза разработки фаза

Стадия вы - Стадия проек - Стадия про - Стадия ис - работкн Тре - тнрования граммирования пытаннй бованнй

Системная спе­цификация н описания под­систем

Программная

Спецификация

Спецификация

Базы данных

Руководство

Пользователя

Руководство по эксплуатации Руководство по сопровождению программ

Рис. 5.11. Документация, выпускаемая на различных стадиях жизненного цикла программного обеспечения [8].

12. Предметный указатель. Указывает номера страниц, где встречаются ключевые понятия, тематические материалы, мето­ды, а также фамилии, цитируемые в тексте.

13. Чистые страницы. Оставляются иногда для заметок поль­зователя или для записей.

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

Жизненный цикл программного обеспечения может быть раз­делен на три фазы: подготовительную, разработки и эксплуата­ции (рис. 5.11).

Подготовительная фаза

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

Фаза разработки

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

Фаза эксплуатации

В этой фазе жизненного цикла программные средства находят­ся в постоянной эксплуатации, выявляются и устраняются ос­тавшиеся в них ошибки, вносятся изменения в соответствии, с новыми требованиями. В этой фазе должен также проводить­ся анализ функционирования системы с целью сопоставления реальных и планируемых выгод и затрат [8].

Проектная системная документация

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

Ниже каждая из стадий фазы разработки программного обеспечения рассматривается отдельно и перечисляются соответ­ствующие ей типы документации. При этом характеризуются цели каждого типа документов, круг его пользователей и наи­более целесообразная форма. Внимательный читатель сразу от­метит определенную избыточность тех или иных документов, но такая избыточность допускается преднамеренно. Вводимая ин­формация, описания входов и выходов и условия проектирова­ния повторяются по двум причинам: во-первых, для обеспечения автономности каждого документа и, во-вторых, для сохранения общности формы и структуры документации. Такой подход по­могает углубить понимание, облегчить подготовку документов и поиск в них нужной информации. Стандартные форматы по­могают увязать ряд компонентов системной документации в единое целое. Предлагаемые ниже структуры документов — примеры возможной документации, они заимствованы из раз - , работок министерства торговли [8].

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

1. Требования к функциональной структуре. Эти требования определяют потребности предлагаемой системы и основу для соглашения пользователей и разработчиков относительно исход­ного описания способа удовлетворения указанных потребно­стей. При этом акцент делается на том, что должно быть сде­лано, а не на том, каким образом. Часто сюда включают описа­ния существующей системы или ручных процедур и проводят анализ присущих им недостатков. Всюду, где это возможно, формулируются требования к соответствующим программным аппаратным средствам. Более подробно содержание этого доку­мента представлено на рис. 5.12.

2. Требования к информационной структуре. Этот документ содержит описание каждого элемента данных, его источника, входных и выходных носителей, начальных значений и измери­тельных шкал. Включаются сюда и требования к процедурам сбора информации. Иногда требования к информационной структуре не выделяются в отдельный том документации, а объ­единяются с требованиями к функциональной структуре. И в том, и в другом случае разработчики должны убедиться, что потенциальные пользователи создаваемой системы понимают

Требования к функциональной структуре

1. ОБЩИЕ СВЕДЕНИЯ

1.1. Аннотация. Характер и назначение разрабатываемого ПО.

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

1.3. Используемые материалы. Перечень материалов, положенных в основу проекта:

А. Сведения о заказчике проекта (с приложением утвержденных до­кументов).

Б. Ранее опубликованные материалы по проекту.

В. Документация по другим родственным проектам.

Г. Прочие материалы.

2. КРАТКОЕ ОПИСАНИЕ РАЗРАБАТЫВАЕМЫХ СРЕДСТВ

2.1. Место в системе программного обеспечения. Цели и масштабы проекта, а также любая другая информация, полезная для читателя документа. Разъяснение связей с другими программными средствами.

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

2.3. Существующие методы и процедуры. Характеризуются процедуры н ме­тоды, удовлетворяющие поставленным целям Затрагиваются следующие вопросы:

А. Распределение обязанностей и ответственности, б Имеющееся н требуемое оборудование.

В. Объемы и частота поступления входной и выходной информации.

Г. Недостатки и действующие ограничения.

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

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

А. Распределение обязанностей н ответственности, б Имеющееся н требуемое оборудование

В. Объемы и частота поступления входной и выходной информации.

Г. Недостатки н действующие ограничения.

Д. Существенные факторы, влияющие на стоимость системы (в ас­пекте ее разработки н эксплуатации).

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

2.5. Планируемые улучшения. Перечисляются выгоды от использования предлагаемого ПО:

А. Новые возможности

Рис. 5.12. Содержание документа, включающего требования к функциональ­ной структуре системы [8]. (ПО — программное обеспечение.)

Б. Совершенствование существующих возможностей.

В. Устранение недостатков действующей системы.

Г. Обеспечение своевременного получения информации посредством уменьшения времени реакции системы и ускорения процессов об­работки данных.

Д. Полное исключение нлн сужение множества ненужных в новой системе функций.

2.6. Влияние иа существующую систему. Характеризуются ожидаемые воз­действия предлагаемого ПО на действующую систему по следующим Направленням:

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

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

2.6.3. Организационные аспекты. Резюмируются:

А. Перераспределение функций.

Б. Сокращение или увеличение штатов.

В. Повышение или понижение требований к уровню квалифи­кации.

2.6.4. Эксплуатационные аспекты. Коротко характеризуются измене­ния по следующим направлениям:

А. Штабные и оперативные функции.

Б. Отношения между операционным центром и пользователями иа рабочих местах.

В. Процедуры в центре оперативных действий.

Г. Данные (источники, объемы, носители, сроки).

Д. Процедуры хранения и поиска данных.

Е. Методы ведения учета и отчетности.

Ж. Последствия отказов и процедуры восстановления работо­способности.

З. Процедуры ввода данных.

И. Потребности в машинных ресурсах.

2.6.5. Особенности разработки.

А. Конкретные функции пользователей в рамках разрабатывае­мого проекта ПО.

Б. Ресурсы, необходимые для разработки базы данных.

В. Вычислительные ресурсы, требуемые для разработки и испы­таний нового ПО.

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

2.8. Альтернативные решения. Рассматриваются возможные альтернативы предлагаемому способу удовлетворения сформулированных требова­ний. Сопоставляются и. критически анализируются все альтернатив­ные решения. Приводится обоснование сделанного выбора.

3. ТЕХНИЧЕСКИЕ ТРЕБОВАНИЯ

3.1. Необходимые функции. Определяются качественные и количественные характеристики функций ПО н показывается, как эти функции обес­печивают достижение установленных целей функционирования сис­темы.

3.2. Рабочие характеристики.

3.2.1. Точность. Описываются требования к точности данных, в том числе

А) математическая точность;

Б) логическая точность;

В) юридическая точность;

Г) точность передачи.

3.2.2. Контроль достоверности. Определяются требования к проверке правильности данных, диктуемые особенностями разрабатывае­мого ПО.

3.2.3. Временные параметры. Указываются применительно к различ­ным условиям работы:

А. Время реакции.

Б. Время обновления данных.

В. Время пересылки данных и передачи нх по каналам связи.

Г. Полное время обработки.

3.2.4. Гибкость. Описываются возможности ПО в части приспособле­ния к изменяющимся требованиям:

А. Изменение режимов работы.

Б. Изменение операционного окружения.

В. Изменение интерфейсов с другими программными средст­вами.

Г. Изменение требований к точности и процедурам ее контроля,

Д. Планируемые изменения и улучшения.

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

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

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

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

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

Б. Нейтрализация отказов. Разъясняется механизм использования другой системы илн альтернативных способов работы для удов­летворения некоторой совокупности требований. Например, мето­дом нейтрализации отказов автоматизированной системы может служить ручная обработка и регистрация данных, в. Восстаиовленне и рестарт. Характеризуются способы восстановле­ния работоспособности и повторного запуска ПО, т. е. описыва­ются возможности возобновления выполнения программы с той точки, перед которой возникла неисправность аппаратных или про­граммных средств, либо перезапуска программы с начальной точки.

4. Рабочая среда

4.1. Оборудование. Определяется комплект оборудования, требующийся для нормальной работы ПО. Если необходимо какое-то новое оборудова­ние, то оно описывается с привязкой к функциям и требованиям, для которых предназначено. Дается следующая информация:

А. Тип процессора и объем внутренней памяти.

Б. Запоминающие устройства, оперативно-доступные и автономные средства, запоминающие среды, формы хранения информации и используемая аппаратура.

В. Оперативно-доступные н автономные устройства ввода — вывода.

Г. Аппаратура передачи данных.

4.2. Вспомогательные программные средства. Характеризуются вспомога­тельные программы н испытательные программные средства. Если работа ПО зависит от изменений средств программной поддержки, то необходимо определить характер и сроки планируемых изменений.

4.3. Интерфейсы. Описываются средства сопряжения с другими програм­мами.

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

4.5. Способы контроля. Характеризуются процедуры контроля ПО, тре­бующиеся в процессе эксплуатации. Указываются условия, приводя­щие к выполнению тех или иных действий по контролю.

5. План разработки

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

Рис. 5.12. Продолжение.

Суть требований к информационной структуре и согласны с ни­ми (рис. 5.13).

Стадия проектирования. На стадии проектирования анализиру­ются требуемые функции системы, связанные с ними ограниче­ния и вырабатываются альтернативные проектные решения. И если на стадии выработки требований решается вопрос о том, что нужно делать, то на рассматриваемой стадии определяют­ся способы реализации конкретных функций, т. е. должен быть получен ответ на вопрос «как?» На стадии проектирования раз­рабатываются спецификации систем и подсистем. При выполне­нии некоторых проектов на этой же стадии заверша-ется подго-

Требования к информационной структуре

1. ОБЩИЕ СВЕДЕНИЯ

1.1. Аннотация. Дается общая характеристика ПО, на которое ориентиро­ваны данные требования.

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

1.3. Используемые материалы. Перечень материалов, положенных в основу проекта:

А. Сведения о заказчике проекта (с приложением утвержденных до­кументов).

Б. Ранее опубликованные материалы по проекту.

В. Документация по другим родственным проектам.

Г. Прочие материалы.

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

2. ОПИСАНИЕ ДАННЫХ

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

2.1. Статические д? к"ые. Перечисляются элементы данных, служащие для Контроля или для ссылок

2.2. /'ги пчческис вводные данные. Перечисляются динамические элементы входных данных, подвергающиеся изменениям в ходе рабочего про­гона программ нли в темпе поступления информации

2.3. Д::нгг-г чеекге выходные данные. Перечисляются динамические элемен­ты выходных данных, подвергающиеся изменениям в ходе рабочего прогона программ илн в темпе поступления информации.

2.4. Ьнуїреннье геьер>;руемыо данные. Характеризуются данные, порождае­мые внутри системы и имеющие информационную ценность для поль­зователя или разработчика.

2.5. Информационные ограничения. Излагаются ограничения на информаци­онные потребности. Указываются границы их дальнейшего расшире­ния или использования: максимальные размеры и число файлов, за­писей, элементов данных. Подчеркиваются ограничения, играющие критическую роль при проведении проектных разработок.

3. ОРГАНИЗАЦИЯ СБОРА ДАННЫХ

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

Ряс. 5.13. Содержание документа, включающего требования к информаци­онной структуре системы [8].

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

Б. Носители исходных данных и устройства ввода Указываются но­сители и аппаратные средства, предназначенные для ввода дан­ных в систему. В тех случаях, когда единственными разрешенными точками ввода информации являются конкретные специализиро­ванные станции, последние должны быть четко определены.

В. Приемники данных. Идентифицируются соответствующие потреби­тели выходной информации

Г Выходные носители и устройства вывода Характеризуются инфор­мационные носители и аппаратные средства, предназначенные для представления результатов потребителю данных. Указывается, в каком виде потребитель должен получать эти результаты: в форме бумажной распечатки, в символической форме на экране дисплея, в виде линнн на чертеже, светового сигнала определенного цвета, звонковой сигнализации и т. п. Если выходная информация дол­жна передаваться в какую-то другую автоматизированную систему, следует охарактеризовать, как это будет осуществляться, через магнитную ленту, перфокарты или путем подачн электронного сиг­нала на соленоидный переключатель д Критические Значення. Отмечаются значения данных, имеющие особую важность для потребителя.

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

Ж. Выполняемые преобразования Описываются конкретные преобра­зования измеряемых количественных величин, которые должны проходить через аналоговые илн дискретные преобразователи

З. Частота обновления и обработки Определяется предполагаемая частота изменения данных и ожидаемая частота обработки вход­ных данных Если входная информация поступает в случайные мо­менты времени нлн при совершении каких-то событий, то подле­жат указанию средняя частота поступления данных и какая-ни­будь мера изменчивости этой частоты.

3.2. Распределение обязанностей по поводу данных. Даются рекомендации по распределению функций подготовки конкретных входных данных, включая организацию специальной группы ввода данных Отдельно отмечаются источники данных, зависящих от интерфейсных про­граммных средств н от внешних организаций

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

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

Рис. 5.13. Продолжение.

Товка руководств для пользователей и планов испытаний, хотя обычно эти два вида документации создаются на более поздних стадиях фазы разработки Все более очевидным становится, однако, тот факт, что появление пользовательских руководств и плана испытаний на возможно более ранних этапах и фазах жизненного цикла системы способствует повышению уровня ее качества. Например, если руководство для пользователя разра­ботано до того, как завершилась разработка проекта системы, проектировщик имеет возможность предусмотреть в своих про­ектных решениях требования к таким свойствам системы, ко­торые считаются важными при учете поведенческого фактора. Требования такого рода выявляются именно при написании пользовательских руководств. Если же руководство для пользо­вателя остается неготовым вплоть до завершения разработки программ, пользовательский интерфейс может в результате приобрести совершенно нежелательные свойства, которые будут очень трудно устранить при наличии готовых программ.

План испытаний тоже наиболее полезен тогда, когда он подготовлен на стадии проектирования. Заблаговременное зна­ние плана испытаний, в соответствии с которым должны оце­ниваться разрабатываемые программные средства, может сти­мулировать более глубокую и более полную проработку вопро­сов организации процессов проектирования и программирова­ния.

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

2. Программная спецификация Иногда этот документ назы­вают внутренней спецификацией, эскизным проектом програм­много обеспечения. Здесь приводятся логическая структура про­грамм, подробное описание входов, выходов и форматов дис­плейных кадров, структуры записей и файлов, требования к хранению информации и к рабочим характеристикам прог­рамм. В отличие от рассмотренных выше документов програм­мная спецификация является по своей сути сугубо техническим документом, предназначенным для программистов, которые в соответствии с ним будут писать программы (рис. 5.15).

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

Системная спецификация и описания подсистем

1. ОБЩИЕ СВЕДЕНИЯ

1.1. Аннотация. Дается общая характеристика функций системы, подлежа­щей разработке, и ее подсистем.

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

1.3. Используемые материалы. Перечень материалов, положенных в основу проекта:

А. Сведения о заказчике проекта (с приложением утвержденных до­кументов).

Б. Ранее опубликованные материалы по проекту.

В. Документация по другим родственным цроектам.

Г. Прочие материалы.

2. ТЕХНИЧЕСКИЕ ТРЕБОВАНИЯ

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

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

2.3. Рабочие характеристики. Определяются требования к рабочим характе­ристикам системы:

2.3.1. Точность. Описываются требования к точности системы и под­систем, в том числе

А) Математическая точность;

Б) Логическая точность;

В) Юридическая точность;

Г) Точность передачи данных.

2.3.2. Контроль достоверности. Определяются требования к проверке правильности данных, диктуемые особенностями разрабатывае­мой системы и ее подсистем.

2.3.3. Временные параметры. Указываются применительно к различ­ным условиям работы:

А. Время реакции.

Б. Время обновления данных.

В. Время пересылки данных и передачи нх по каналам связи.

Г. Полное время обработки.

2.3.4. Гибкость. Описываются возможности системы и подсистем в части приспособления к изменяющимся требованиям:

А. Изменение режимов ррбогы.

Б. Изменение операционного окружения.

В. Изменение интерфейсов с другими программными средст­вами.

Г. Изменение требований к точности и процедурам ее контроля.

Д. Планируемые изменения и улучшения.

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

Рис. 5.14. Содержание системной спецификации и описания подсистем [8J.

3. Рабочая среда

3.1. Оборудование. Определяется комплект оборудования, требующийся для нормальной работы системы и ее подсистем. Если необходимо какое - то новое оборудование, то оно описывается с привязкой к функциям н требованиям, для которых предназначено. Дается следующая ин­формация:

А. Тип процессора и объем внутренней памяти.

Б. Запоминающие устройства, оперативно-доступные и автономные средства, запоминающие среды, формы хранения информации и используемая аппаратура.

В. Оперативно-доступные и автономные устройства ввода — вывода.

Г. Аппаратура передачи данных.

3.2. Вспомогательные программные средства. Характеризуются вспомога­тельные программы н испытательные программные средства. Если работа системы н подсистем зависит от изменений средств про­граммной поддержки, то необходимо определить характер и сроки планируемых изменений.

3.3. Интерфейсы. Описываются средства сопряжения с другими системами программного обеспечения.

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

3.5. Способы контроля. Характеризуются процедуры контроля за функцио­нированием системы и подсистем. Указываются условия, приводящие к выполнению тех илн нных действий по контролю.

4. Проектные характеристики

4.1. Рабочие операции. Описываются условия эксплуатации ПО системы в

Вычислительных центрах и в пользовательской среде.

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

5. Требования к программам

5.1. Описание программы (имя). Определяются функции системы или под­системы, обеспечиваемые данной программой:

А. Формулируются требования к программе.

Б. Характеризуется операционное окружение.

В. Указываются проектные параметры программы, включая входы, алгоритм обработки, выходы и базу данных.

5.N. Описание программы (имя). По типу п. 5.1 описывается каждая из про­грамм.

Рис. 5.14. Продолжение.

К конкретному проекту. Это тоже документ технического харак­тера, ориентированный на разработчиков проекта и программи­стов (рис. 5.16).

4. Руководство для пользователя. Документ предназначен для пользователей системы и потому не должен содержать сугубо технической терминологии. Цель этого документа — объ­яснить все, что должен знать пользователь для эффективной

Программная спецификация

1. ОБЩИЕ СВЕДЕНИЯ

1.1. Аннотация. Дается общее описание и характеризуются функции машин­ной программы, подлежащей разработке

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

1.3. Используемые материалы. Перечень материалов, положенных в основу проекта:

А. Сведения о заказчике проекта (с приложением утвержденных до­кументов) .

Б. Ранее опубликованные материалы по объекту проектирования.

В. Документация по другим родственным проектам.

Г. Прочие справочные материалы.

2. ТЕХНИЧЕСКИЕ ТРЕБОВАНИЯ

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

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

2.3. Рабочие характеристики. Определяются требования к рабочим характе­ристикам программы.

2.3Л. Точность. Описываются требования к точности данных, в том числе

А) математическая точность;

Б) логическая точность;

В) юридическая точность;

Г) точность передачи данных.

2.3.2. Контроль достоверности. Определяются требования к проверке правильности данных, диктуемые особенностями разрабатывае­мой программы.

2.3.3. Временные параметры. Указываются применительно к различ­ным условиям работы:

А. Время реакции.

Б. Время обновления данных.

В. Время пересылки данных и передачи их по каналам связи.

Г. Полное время обработки.

2.3.4. Гибкость. Описываются возможности программы в части при­способления к изменяющимся требованиям:

А. Изменение режимов работы.

Б. Изменение операционного окружения.

В Изменение интерфейсов с другими программными средст­Вами.

Г. Изменение требований к точности и процедурам ее контроля.

Д. Планируемые изменения и улучшения.

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

Рис. 5.15. Содержание программной спецификации [8].

3. РАБОЧАЯ СРЕДА

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

А. Тип процессора и объем внутренней памяти.

Б. Запоминающие устройства, оперативно-доступные и автономные средства, запоминающие среды, формы хранения информации и используемая аппаратура.

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

Г. Аппаратура передачи данных

3.2. Вспомогательные программные средства. Характеризуются вспомогатель­ные программы и испытательные программные средства. Если работа программы зависит от изменений средств программной поддержки, то необходимо определить характер и сроки планируемых изменений.

3.3. Интерфейсы. Описываются все взаимодействия с оператором, а также средства сопряжения с другими программами, включая последова­тельности процедур и информационные интерфейсы

3.4. Хранение информации. Определяются требуемые объемы памяти, усло­вия хранения и действующие ограничения.

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

Б. Запоминающие устройства. Перечисляются все типы требуемых внешних (ЗУ. Вкратце рассматриваются все ограничения, свойст­венные каждому типу Излагаются требования к ЗУ для постоян­ного н временного хранения информации, в том числе оверлейной структуры.

В. Автономные ЗУ. Формулируются требования к форме хранения, за­поминающей среде и необходимому объему памяти применительно ко всем автономным ЗУ.

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

3.6. Способы контроля. Характеризуются способы контроля правильности ра­боты программы: подсчет числа записей, нарастающие нтогн н кон­трольные суммы. Указываются условия, приводящие к выполнению тех или иных действий по контролю.

4. ПРОЕКТНЫЕ ХАРАКТЕРИСТИКИ

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

4.2. Входы. Приводятся характеристики каждого программного входа:

А. Имя и метка.

Б. Формат и тип данных с указанием шаблона записи.

В. Критерии правильности.

Г. Объем и частота.

Д. Способ ввода.

Е. Первичный документ-источник н его местонахождение или соответ­ствующий интерфейсный источник.

Ж. Условия защиты и обеспечения конфиденциальности.

4.3. Логика программы. Описывается программная логика и представляет алгоритм в виде блок-схемы либо таблицы решений с сопутствующими текстовыми пояснениями.

4.4. Выходы. Приводятся характеристики каждого программного выхода:

А. Имя и метка.

Б. Формат (например, в виде отчета).

В. Критерии отбора для отображения на экране, выдачи на печать или передачи по каналу связи.

Г. Объем и частота.

Д. Выходные носители.

Е. Описание графических отображений и символических представле­ний.

Ж. Условия защиты и обеспечения конфиденциальности.

З. Местонахождение результатов.

И. Описание последовательности отображений, содержания информа­ционных кадров, фиксированных и переменных форматов, условий возникновения ошибок.

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

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

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

Рис. 5.15. Продолжение.

Работы в системе. В зависимости от конкретной направленно­сти руководство пользователя может носить характер (либо учебного пособия, либо справочника, однако в обоих случаях оно содержит детальное описание процедур ввода данных и па­раметров программ, интерпретации результатов и исправления ошибок. Применительно к сложным процессам взаимодействия пользователя с ЭВМ должны обязательно представляться ри­сунки или иные иллюстрации содержимого дисплейных кадров информации наряду с описанием манипуляций на клавиатуре, соответствующих приводимым кадрам.

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

Спецификация базы данных

1. ОБЩИЕ СВЕДЕНИЯ

1.1. Аннотация. Характеризуется целевое назначение базы данных и пере­числяются функции ПО, которое в ней используется.

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

1.3. Используемые материалы. Перечень материалов, положенных в основу разработки базы данных:

А. Сведения о заказчике проекта (с приложением утвержденных до­кументов).

Б. Ранее опубликованные материалы по объекту проектирования.

В. Документация по другим родственным проектам.

Г. Прочие справочные материалы.

2. ОПИСАНИЕ БАЗЫ ДАННЫХ

2.1. Способ идентификации. Указываются имя, ярлык или метка, по которым Возможна идентификация базы данных Если бант да Іььіх я^тяется Экспериментальной, испытательной или временной, то сообщается этот признак, а также планируемый срок ее существования. Должна указываться и любая другая идентифицирующая информация.

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

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

2.4. Особые указания. Формулируются специальные инструкции персоналу, который будет участвовать в формировании базы данных либо мо­жет использовать ее с целью контроля или применения в своей рабо­те. 'іакие инструкции включают в себя критерии, процедуры и фор­маты:

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

Б) для ввода отобранной информации в базу данных

В случае слишком пространных инструкций даются отсылки к соот­ветствующим разделам других документов.

2.5. Ееомогательные грогр^мм!'ые средства. Кратко характеризуются все вспомогательные программы, непосредственно связанные с базой дан­ных. Описание должно включать в себя имя программы, выполняе­мые функции, основные рабочие характеристики и инструкции по ис­пользованию. В ссылках на документацию вспомогательных про­граммных средств указываются название документа, номер тома и номер соответствующего раздела.

Примеры вспомогательных программных средств:

А. Системы управления базами данных.

Б. Программы распределение памяти.

В. Программы загрузки базы данных

Г. Программы обработки файлов.

Д. Прочие генерирующие, модифицирующие нли обновляющие про­граммы.

Рис. 5 16. Содержание спецификации базы данных [8].

Гчявя "і

3. Логические характеристики

База данных представляет собой совокупность логически упорядоченных информационных объектов. Наборы (агрегаты) данных, файлы, записи, элементы и позиции могут различаться по месту расположения в логи­ческой структуре и по имеющимся связям. Настоящий раздел «Специ­фикации» должен быть организован таким образом, чтобы у читающего этот документ складывалось целостное и осмысленное представление о логической структуре базы данных. В этом разделе по каждому инфор­мационному объекту определяются:

А. Способ идентификации. Имя и метка или ярлык.

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

В. Связи. Описываются связи с вышестоящими и нижележащими элементами, а также порядок обращения н обновления.

4. Физические характеристики

4.1. Хранение информации. Определяются требования к ЗУ для хранения базы данных, действующие условия и ограничения

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

Б. Запоминающие устройства. Перечисляются все типы требуемых внешних ЗУ для хранения базы данных. Вкратце рассматриваются все ограничения, свойственные каждому типу. Излагаются требо­вания к ЗУ для постоянного и временного хранения информации, в том числе оверлейной структуры.

В. Автономные ЗУ. Формулируются требования к форме хранения, запоминающей среде и необходимому объему памяти применитель­но ко всем автономным ЗУ.

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

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

Рис. 5.16. Продолжение.

5. План испытаний. План испытаний обеспечивает програм­миста подробным описанием всех тестов, которые должны пройти разрабатываемые программные средства. Этот документ содержит текстовые данные и оценочные критерии; содержание документа представлено на рис. 5.18.

Стадия программирования. Основной продукт этой стадии — за­кодированные программы. Одновременно подготавливаются ру­ководство по сопровождению и инструкция по эксплуатации;

Руководство пользователя

1. ОБЩИЕ СВЕДЕНИЯ

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

Условия фуикционироваиня. Определяется организация пользователя или вычислительный центр, где устанавливаются созданные программ­ные средства.

Используемые материалы. Перечень материалов, положенных в основу проекта

А. Сведения о заказчике проекта (с приложением утвержденных до­кументов).

Б. Ранее опубликованные документы по проекту.

В. Документация по другим родственным проектам.

Г. Прочие справочные материалы.

2. ОПИСАНИЕ ПРИМЕНЕНИЯ

Общее описание. Определяются время и способ использования ПО, а также выгоды организации от его применения. В описании должны присутствовать разделы:

А. Назначение ПО.

Б. Предоставляемые возможности и достигаемые улучшения.

В. Выполняемые функции.

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

Оборудование. Характеризуются аппаратные средства, на которых реа­лизуется ПО

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

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

А. Количественные параметры входов, выходов, времени реакции, вре­мени обработки и частоты ошибок.

Б. Качественная информация о свойствах функциональной гибкости и надежности.

База данных. Описываются все файлы данных, запрашиваемые, поддер­живаемые или* сохраняемые в неизменном виде программными сред­ствами. Должны обязательно указываться цели ведения каждого из файлов

Входы, процесс обработки и выходы. Приводится описание входов, по­токов обрабатываемых данных через весь цикл обработки и резуль­тирующих выходов. Характеризуются все существующие взаимосвязи входов и выходов.

3. ТРЕБОВАНИЯ К ПРОЦЕДУРАМ

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

Рис. 5.17. Содержание руководства для пользователя [8].

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

Запуск. Описывается каждый шаг процедур, необходимых для инициа­лизации процесса обработки.

Ввод данных. Определяются требования к процедуре подготовки вход­ных данных и настройке параметров. При этом характеризуются:

А. Условия — необходимый персонал, производимые перемещения или нехватка нужных специалистов и др.

Б. Частота ввода — например периодически, в случайные моменты времени, в зависимости от рабочей обстановки.

В. Источники данных—например отдел кадров, система управления запасами.

Г. Носители информации — например клавиатура, перфокарта, маг­нитная лента, бумажная лента.

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

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

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

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

А) длина — например число знаков в строке и в элементе дан­ных;

Б) формат—например текст, выровненный по левому краю;

В) метки — например ярлыки или идентификаторы;

Г) порядок расположения — например последовательность и местоположение всех элементов входного сообщения;

Д) правила пунктуации — например правила использования про­белов и специальных символов (запятой, звездочки, символь­ных комбинаций и т. п.) для обозначения начала н коица ввода, начала и конца строк или блоков данных и т. д.;

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

Ж) словарь — например в виде приложения, в котором пере­числены допустимые комбинации символов нли разрешенные коды для идентификации либо компоновки элементов вход­ных сообщений;

З) опускаемые или повторяемые элементы — например элемен­ты, которые не обязательны илн могут многократно повто­ряться в сообщении;

И) контрольные элементы — например контрольные данные в заголовке нли концевой части сообщения.

3.2.2. Примеры форм ввода. Приводятся образцы всех сложных вход­ных форм с сопутствующим их описанием, в котором должны быть представлены:

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

Б) текстовая информация — например блоки входного сообще­ния, которые содержат данные для рабочих файлов, пара­метры запросов и сведения, необходимые информационно - поисковой программе;

В) концевик — например контрольные данные, обозначающие конец ввода, и т. п.;

Г) опускаемые элементы — например классы или типы элемен­тов входных сообщений, которые могут опускаться или яв­ляются не обязательными;

Д) повторения — например элементы входного сообщения, кото­рые могут многократно повторяться.

3.3. Выходы. Описываются требования, предъявляемые к каждому выходу.

При этом характеризуются:

А) способ использования — например кто и для чего использует дан­ный результат;

Б) частота — например неделя, конкретный период или выдача по за­просу;

В) варианты — например возможные модификации результата;

Г) назначение — например другой узел вычислительной системы или удаленный терминал;

Д) информационный носитель — например распечатка, экран дисплея, лента, карты;

Е) контроль достоверности — например инструкции по идентифика­ции, проверке допустимости, редактированию и исправлению оши­бок;

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

3.3.1. Форматы вывода Представляются макеты всех выходов. Объ­яснения привязываются к конкретным разделам выходной формы:

А) заголовок — например название, идентификатор, дата, чис­ло, количество разделов;

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

В) концевик — например итоговые суммы для контроля и кон­цевые метки.

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

А) определение — например смысл и способ использовании каж­дой переменной, присутствующей в информации;

Б) источник данных — например элемент, извлеченный из кон­кретного входного документа, из файла базы данных, или вычисленный программой;

В) характеристики — например наличие или отсутствие конкрет­ной позиции при определенных условиях формирования ре­зультата, диапазон значений, единицы измерения.

3.4. Возможные ошибки и процедуры их устранения. Перечисляются коды ошибок или условий, порождаемые программными средствами, и не­обходимые корректирующие действия пользователя. Указываются процедуры, которым должен следовать пользователь, чтобы гаран­тировать успешное применение возможных операций восстановления (работоспособности системы и ее повторного запуска.

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

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

Рис. 5.17. Продолжение.

План испытаний

1. ОБЩИЕ СВЕДЕНИЯ

1.1. Аннотация. Кратко описываются функции ПО и необходимые тесты.

1.2. Условия проведения испытаний и предыспытательный период. Излага­ется краткая предыстория проекта. Определяются организация поль­зователя и вычислительный центр, где должны Проводиться испыта­ния. Описываются все предшествующие результаты тестирования и отмечаются те из них, которые могут повлиять на проведение теку­щих испытаний.

1.3. Используемые материалы. Перечень материалов, положенных в основу проекта:

А. Сведения о заказчике проекта (с приложением утвержденных до­кументов) .

Б. Ранее опубликованные документы по проекту.

В. Документация по другим родственным проектам.

Г. Прочие справочные материалы.

2. ПЛАН ИСПЫТАНИЙ

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

2.2. Основные этапы. Определяются пункты проведения испытаний, основные фиксируемые события и даты испытаний.

2.3. Программа испытаний (в конкретном пункте). Указываются участвую­щие организации и место проведения испытаний ПО.

2.3.1. График испытаний. Приводится детализированный график про­водимых в данном пункте испытаний, содержащий ключевые да­ты и события. К числу таких событий могут относиться озна­комление с испытываемой системой ПО, обучение, получение нужных данных, объем и частота ввода.

Рис. 5.18. Содержание документа «План испытаний» [8].

2.3.2. Требования. Определяются потребности в соответствующих ре­сурсах, в том числе

А) оборудование. Указываются ожидаемый период использова­ния в испытательных целях, >типы и количество необходимых единиц оборудования;

Б) программные средства. Перечисляются внешние программные средства, которые потребуются для проведения испытаний данной системы ПО;

В) персонал. Определяются потребности в персонале различной квалификации как со стороны пользователя, так и со сто­роны разработчика. Отмечаются все специфические требова­ния типа многосменной работы или необходимых основных категорий персонала.

2.3.3. Материалы по проведению испытаний. Перечисляются все тех­нические материалы, необходимые для Оіраннзации испытаний:

А. Документация.

Б. Испытываемые программные средства на соответствующих носителях.

В. Контрольные примеры с их ожидаемыми выходами.

Г. Испытательные программные средства и бланки, подлежащие заполнению.

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

2.4. Программа испытаний (в очередном пункте). Приводится план испыта­ний во втором пункте, а затем во всех последующих аналогично то­му, как это сделано применительно к первому /пункту в соответствии с разд. 2.3.

3. ТЕХНИЧЕСКИЕ ТРЕБОВАНИЯ И ОЦЕНКА РЕЗУЛЬТАТОВ

3.1. Спецификация испытаний.

3.1.1. Требования. Перечисляются требования к функционированию, изложенные в предшествующих документах.

3.1.2. Функции ПО. Подробно перечисляются функции ПО, подлежа­щие Іпроверке в ходе испытаний.

3.1.3. Распределение тестов по функциям ПО. Характеризуются тес­ты, подлежащие прогону при проверке каждой функции из разд. 3.1.2.

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

3.2. Методы и ограничения.

3.2 1. Методология проведения испытаний. Описывается основной ме­тод илн выбранная стратегия испытаний. 3 2 2. Условия испытаний. Определяется тип используемых входов (например, реальные или тестовые данные), а также устанавли­ваются необходимые объем и частота ввода. 3.2.3. Глубина проверок. Указывается уровень проводимых испытаний (полные или частичные). Приводятся обоснования правомерно­сти частичных испытаний 3 24. Регистрация проверок. Описывается необходимый метод фикса­ции результатов испытаний и другой сопутствующей испытани­ям информации.

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

3.3. Оценка результатов.

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

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

4. описание испытании

4.1. Тест (с идентификатором). Описывается выполняемый тест.

4.1.1. Организация прогона. Характеризуется способ управления тес­тированием (ручной, полуавтоматический, автоматический) при­менительно к заданию входов, упорядочению операций и реги­страции результатов.

4.1.2. Входы. Описываются входные данные и команды ввода, ис­пользуемые Піри прогоне теста.

4.1.3. Выходы. Описываются выходные данные, ожидаемые в качестве результата тестирования, и возможные промежуточные сооб­щения.

4.1.4. Процедуры. Определяются по шагам процедуры реализации тес­та, включая настройку, инициирование, пошаговое выполнение и завершение.

4.2. Тест (с идентификатором). Далее описываются второй и все последую­щие тесты аналогично тому, как это сделано в разд. 4.1.

Рис. 5.18. Продолжение.

Сам текст программы может включаться в руководство по со­провождению.

1. Руководство по эксплуатации. Этот документ предостав­ляет всю информацию, необходимую для правильного использо­вания системы. Документ предназначен для персонала операто­ров ЭВМ. Он содержит общее описание системы программного обеспечения, рабочих процедур, способов сохранения целостно­сти данных и конкретных требований к регламенту работы (рис. 5.19).

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

Руководство по эксплуатации

1. ОБЩИЕ СВЕДЕНИЯ

1.1. Аннотация. Дается общая характеристика функций ПО.

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

1.3. Используемые материалы. Перечень цитируемых материалов:

А. Сведения о заказчике проекта (с приложением утвержденных до­кументов).

Б. Ранее опубликованные материалы по проекту.

В. Документация по другим родственным проектам.

Г. Прочие справочные материалы.

2. КРАТКОЕ ОПИСАНИЕ СИСТЕМЫ

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

2.2. Опись программ. Идентифицируется каждая программа по ее имени, но­меру и мнемоническому коду для обращения.

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

3. ОПИСАНИЕ ПРОГОНОВ

3.1. Опись рабочих прогонов. Перечисляются возможные ситуации использо­вания и характеризуются цели каждого ирогона. Указываются про­граммы, участвующие в каждом прогоне.

3.2. Организация рабочих прогонов. Описывается способ организации рабо­чего цикла с переходом от одного прогона к другому вплоть до пол­ного завершения цикла.

3.3. Описание прогона (с привязкой к идентификатору). Информация, харак­теризующая порядок работы в рамках данного прогона, представля­ется в форме, наиболее удобной для оперативного центра и опера­тивного персонала.

3.3.1. Управляющие входы. Перечисляются управляющие команды,

Необходимые для выполнения прогона. 3 3.2. Эксплуатационные характеристики. Представляется информация для эксплуатационного персонала и для руководства вычисли­тельного центра:

А. Идентификатор прогона.

Б. Функциональные требования.

В. Способ инициализации (по запросу, в установленное время и т. п.).

Г. Оценка длительности прогона и полного цикла обработки.

Д. Операторские команды и сообщения.

Е. Специалисты для контактов при возникновении цроблем.

3 3.3. Входные и выходные файлы. Приводятся сведения о файлах, создаваемых или обновляемых в ходе прогона:

А. Имя или метка файла.

Б. Запоминающая среда.

В. Срок хранения.

Рис. 5.ІІ9. Содержание инструкции по эксплуатации [8].

Г. Местонахождение файла.

3.3.4. Результирующие отчеты. По каждому выходному документу или типу документов дается следующая информация:

А. Идентификатор отчета.

Б. Носитель.

В. Объем.

Г. Количество экземпляров.

Д. Порядок распространения.

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

А. Идентификатор отчета.

Б. Способ репродуцирования.

В. Формат бумаги или иных носителей.

Г. Способ брошюровки.

Д. Порядок распространения.

3.3.6. Процедуры восстановления и рестарта.

3.4. Описание прогона (с привязкой к идентификатору). Представляется ин­формация о следующем по порядку прогоне — по типу описания в Разд. 3.3.

4. НЕСТАНДАРТНЫЕ ПРОЦЕДУРЫ

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

А. Переключение на резервную систему.

Б. Процедуры обращения к программистам группы сопровождения.

5. ДИСТАНЦИОННЫЕ ОПЕРАЦИИ

Описываются процедуры, связанные с прогоном программ по запросу удаленных терминалов.

Рис. 5.19. Продолжение.

Включены проектная документация и тексты программ (рис. 5.20).

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