Программирование на языке высокого уровня. Замятин А.В - 27 стр.

UptoLike

27
Несмотря на довольно существенные различия в подходах к написанию
руководства пользователя, можно рекомендовать следующие обязательные
разделы:
1. «О программе» описание программы, назначение и основные воз-
можности.
2. «Системные требования» список аппаратных и программных
средств и их характеристик, необходимых для запуска и успешного
функционирования программы.
3. «Интерфейс» описание интерфейса программы, основных элемен-
тов управления и горячих клавиш. При наличии графического интер-
фейса необходимо привести скриншоты, иллюстрирующие интерфейс
пользователя.
4. «Запуск программы» описание действий, необходимых для запуска
программы.
5. «Работа с программой» пошаговое описание основных действий (в
соответствии с выбранным подходом к написанию руководства), ко-
торые доступны в программе, с пояснениями и скриншотами-
примерами.
6. «Приложение». Необязательный раздел, добавляется при необходи-
мости и может включать любые сведения, не вошедшие в вышепере-
численные разделы, например, глоссарий.
Необходимо учитывать, что руководство пользователя пишется для лю-
дей, которые, вполне возможно, плохо умеют работать с компьютером и не
знакомы со многими понятиями информационных технологий. Поэтому ру-
ководство пользователя следует писать понятным языком, по возможности
употребляя как можно меньше специфической терминологии и аббревиатур.
Также не допускается использование жаргонной лексики.
Структура предложений должна быть как можно более простой, не пере-
груженной сложными речевыми оборотами.