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

Появление такого документа явилось следствием широкого распространения персональных компьютеров, работая на которых, пользователи совмещают в своем лице программиста, системного программиста и оператора. Пользователь, как правило, не является профессионалом в области разработки ПО. Поэтому, по книге С.Д.Гримма «Как писать руководство для пользователей» (пер. с англ. 1995г) можно использовать следующие рекомендации:

v учитывать интересы пользователя (руководство должно содержать все инструкции, необходимые пользователю)

v излагать ясно, используя короткие предложения

v избегать технического жаргона и узко специальной терминологии, используемые термины пояснять

v по возможности использовать рисунки

Руководство содержит разделы:

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

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

· описание запуска (описаний действий по запуску)

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

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