Приложение А. Инструкция пользователю

У хорошо документированного программного продукта (ПП) имеются следующие преимущества:

1. Легкость использования. Если ПП хорошо документирован, то его гораздо легче применять. Пользователи его быстрее изучают, делают меньше ошибок, а в результате быстрее и эффективнее выполняют свою работу.

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

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

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

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

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

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

Руководство пользователя АС разрабатывается в соответствии с требованиями подраздела 3.4 РД 50-34.698-90. Комплекс стандартов и руководящих документов на автоматизированные системы. Автоматизированные системы. Требования к содержанию документов. Методические указания. Код документа — ИЗ. Документ содержит разделы:

• введение;

• назначение и условия применения;

• подготовка к работе;

• описание операций;

• аварийные ситуации;

• рекомендации по освоению.

В разделе «Введение» указывают:

• область применения;

• краткое описание возможностей;

• уровень подготовки пользователя;

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

В разделе «Назначение и условия применения» указывают:

• виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации;

• условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.).

В разделе «Подготовка к работе» указывают:

• состав и содержание дистрибутивного носителя данных;

• порядок загрузки данных и программ;

• порядок проверки работоспособности.

В разделе «Описание операций» указывают:

• описание всех выполняемых функций, задач, комплексов задач, процедур;

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

Для каждой операции обработки данных указывают:

• наименование;

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

• подготовительные действия;

• основные действия в требуемой последовательности;

• заключительные действия;

• ресурсы, расходуемые на операцию.

В описании действий допускаются ссылки на файлы подсказок, размещенные на магнитных носителях.

В разделе «Аварийные ситуации» указывают:

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

• действия по восстановлению программ и (или) данных при отказе магнитных носителей или обнаружении ошибок в данных;

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

• действия в других аварийных ситуациях.

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

Оформление документа — в соответствии с требованиями ГОСТ 2.105-95. Единая система конструкторской документации. Общие требования к текстовым документам на листах формата А4 по ГОСТ 2.301-68. Единая система конструкторской документации. Форматы, с рамкой и основной надписью.

Поиск по сайту: