Подготовка руководства пользователю по диалоговой прикладной программе

Часть 1 (Состав)

Предисловие (общий раздел).

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

Оглавление (общий раздел).

Раздел А: Введение.

I. Назначение.

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

III. Ограничения.

IV. Дополнительная информация.

Раздел В: Общая информация.

I. Допустимые элементы входных данных.

II. Имеющиеся в наличии виды обработки.

III. Ограничения.

IV. Выходные данные.

V. Управляющие директивы диалоговой операционной системы.

VI. Управляющие директивы для оборудования / программы.

VII. Организация входного потока.

Раздел С: Выполнение задания.

I. Начало диалоговых операций.

II. Загрузка Программы (название диалоговой программы)

III. Запуск программы (название диалоговой программы)

IV. Ввод входных данных.

V. Процедура обработки ошибок.

а. (Название диалоговой программы)

б. (Название операционной системы)

VI. Изменение входных данных.

VII. Прерывание программы (название диалоговой программы)

VIII. Повторный запуск программы (название диалоговой программы)

IX. Получение выходных данных.

X. Завершение работы (название диалоговой программы)

XI. Окончание диалоговых операций.

Приложение: Сообщения системы.

Словарь терминов (общий раздел).

Часть II (Содержание основных компонентов)

При подготовке этого раздела «Руководства» включите следующую информацию:

- пользователь относится к тем, кто связан с вычислительной машиной или пользуется программой коммерческих/технических применений посредством удаленных терминалов.

«Рекомендации», которые вы готовите, должны подробно объяснять:

- как использовать «Руководство», чтобы сделать наиболее эффективной работу определенной прикладной программы;

- как использовать ваши инструкции в качестве практического руководства при выполнении программы с удаленного терминала.

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

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

Раздел а: Введение

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

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

I Назначение. Определите четко и кратко объясните назначение программы.

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

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

Не вдавайтесь здесь в детали. Эта информация должна быть рассмотрена более подробно в разделе В под заголовком «Имеющиеся в наличии виды обработки».

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

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

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