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

3.1. Общие замечания

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

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

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

31

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

Целесообразно дать иллюстрации в виде экранов с описанием особенностей манипуляций на клавиатуре.

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

Руководство пользователя содержит следующие разделы:

• общие сведения;

• описание применения;

• требования к процедурам.

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

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

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

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

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

В отдельном подразделе руководства должны быть указаны возможные ошиб­ки и процедуры их устранения. Целесообразно перечислить коды возможных оши-

32

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

3.2. Содержание разделов руководства

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

1. Общие сведения

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

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

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

2. Описание применения

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

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

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

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

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

2.6. База данных . Приводится общая логическая структура базы данных и
описываются все файлы с указанием их назначения.

2.7. Схемы Н 1 РО . Приводится общая схема обработки данных в системе с
возможной разбивкой по режимам функционирования. Каждый блок обработки
снабжается описанием потоков входных и выходных данных.

3. Требования к процедурам функционирования системы

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

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

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

33

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

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

3.2.2. Примеры форм для ввода данных ( экранов ). Приводятся примеры
всех входных форм с подробным их описанием и заполненные конкретными данны­
ми. Для каждого реквизита указываются на примерах особенности вводимой инфор­
мации.

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

3.3.1. Форматы вывода . Приводятся макеты всех выходных форм и эк­
ранов с объяснениями каждого раздела формы.

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

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

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

План приемо - сдаточных испытаний

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

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

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

34

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

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

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

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

Документ содержит следующие разделы:

- Общие сведения.

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

- Технические требования к испытаниям и оценка результатов.

- Описание испытаний.

1. Общие сведения .

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

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

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

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

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

3. Технические требования к испытаниям и оценка результатов .

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

3.1.1. Требования .

3.1.2. Функции программного изделия .

3.1.3. Распределение тестов по функциям программного изделия .

3.1.4. Последовательность прогона тестов .

3.2. Методы и ограничения . Кроме описания тестов, определяется общая ме­
тодология проведения испытаний и условия проведения испытаний, включающие
тип используемых тестовых данных, параметры потоков тестовых данных и полнота
проводимых испытаний (полные, частичные, выборочные).

35

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

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

3.2.1. Методология проведения испытаний .

3.2.2. Условия проведения испытаний .

3.2.3. Глубина проверок .

3.2.4. Регистрация результатов проверок .

3.2.5. Ограничения возможностей проводимых испытаний .

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. Гест ( с идентификатором ). Описываются последующие тесты.

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

36

Приложение 2

Типовая форма титульного листа курсового проекта

Ответственность за сведения, представленные в издании, несут авторы.

ГОСУДАРСТВЕННЫЙ УНИВЕРСИТЕТ УПРАВЛЕНИЯ

Институт информационных систем управления Кафедра компьютерных технологий

КУРСОВОЙ ПРОЕКТ

по дисциплине "Экономика, разработка и использование программных средств"

на тему

Методические указания к курсовому проектированию