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

 

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

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

- изложение должно быть ясным, короткими предложениями;

- следует избегать технического жаргона и узко специальной терминологии;

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

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

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

- описание установки(подробное описание действий по установке программного продукта и сообщений, которые при этом могут быть получены);

- описание запуска(описание действий по запуску программы и сообщений, которые при этом могут быть получены);

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

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