В секции инструкций материал руководства должен быть упорядочен в соответствии с последовательностью обучения, начиная с простейших и наиболее необходимых операций, появляющихся в первую очередь, и заканчивая более сложными и появляющимися позже. Размер этой секции зависит либо от принятой методики обучения, либо от особенностей коллектива пользователей: некоторые из пользователей могут понять возможности и особенности использования программного изделия после знакомства с небольшим числом примеров, в то время как другим может потребоваться изучение многочисленных примеров.
В справочной секции должны быть представлены основные операции, упорядоченные для удобства использования, например, по алфавиту. Докумен-
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. Возможные ошибки и процедуры их устранения. Перечисляются коды
ошибок, возникающих в процессе работы программы, и описываются необходимые
действия пользователя по их корректировке. Указываются процедуры восстановле
ния работоспособности системы при ошибках.