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

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

Составление документации для пользователей имеет свои особенности, связанные с тем, что пользователь, как правило, не является профессионалом в области разработки программного обеспечения. В книге С. Дж. Гримм [17] даны рекомендации по написанию подобной программной документации:

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

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

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

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

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

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

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

В разделе Запуск, как правило, описаны действия по запуску программного продукта и сообщений, которые при этом могут быть получены.

Раздел Инструкции по работе обычно содержит описание ре­жимов работы, форматов ввода-вывода информации и возмож­ных настроек.

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