Команда > Авторские публикации > 2016 год > Особенности разработки пользовательской документации

Особенности разработки пользовательской документации

Занимаясь разработкой технической документации с использованием ГОС или требований заказчика, нужно четко знать о необходимости тщательного документирования описания работы с той или иной информационной автоматизированной системой (АС).

Все дело в том, что с любой АС работают люди. В большинстве случаев разобраться с ней самостоятельно без пользовательской документации довольно сложно. Поэтому, именно об особенностях написания пользовательской документации пойдет речь в данной статье.

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

  • технологическая (программная) документация — используется при проектировании, создании системы;
  • эксплуатационная (пользовательская) документация — описывает, как использовать систему, обеспечивает возможность эффективного применения АС пользователями.

Далее рассмотрим подробнее специфику подготовки пользовательской документации.

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

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

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

Руководство пользователя обязательно должно быть адаптировано к особенностям восприятия пользователя. При разработке подобных документов рекомендуется обратить внимание на следующие моменты:
  • Структура и логика изложения должны быть удобными и эффективными для систематического чтения и усвоения сведений;
  • Удобный поиск в документе конкретных сведений. Оглавление, указатели, перекрестные ссылки облегчают поиск нужных сведений;
  • Сведения общего характера в документе лучше ограничивать лишь теми знаниями, которые необходимы для конкретного целевого применения АС. Конкретные объекты, элементы интерфейса, лица, программные средства должны иметь уникальные идентификаторы;
  • Уровень подробности должен быть достаточным для того, чтобы документ выполнял поставленные перед ним задачи. Полнота сведений должна складываться из обширности сведений (определяется темой и назначением документа), их завершенности и их точности;
  • Действия пользователя в интерфейсе АС лучше описывать так, чтобы пользователь получил полное представление о том, как именно выполнить конкретное действие;
  • Для удобства пользователя, глубина формальной структуры документа по возможности не должна превосходить 4 уровня. Документ должен иметь четкую структуру. Если глубина структуры все же входит за рамки 4 уровня, то значит необходимо обратить внимание на выбор изложения материала, возможно автор недооценил значимость какого-либо структурного элемента и следует повысить уровень его иерархии;
  • Использовать способ структурирования сплошного текста — перечисление, табличная форма и т.д. Данный вид изложения помогает пользователю оптимально, быстро воспринимать и правильно понимать информацию;
  • Избегать описания громоздких и ветвящихся процедур. Линейная последовательность процедуры нарушается в результате ветвления, это означает, что пользователь уже не сможет рассматривать процедуру как определенную последовательность шагов. Наглядность процедуры при этом страдает, пользователь путается. Лучше разбить объект на составные части и рассмотреть каждую часть отдельно;
  • Порядок изложения сведений во всем документе должен быть унифицирован. Избранный в документе при изложении сведений определенный порядок, при описании других сведений должен соблюдаться;
  • Избегать в документации образных выражений, употребление слов в переносном значении, шутливых высказываний и т.д. Изложение должно быть предельно точное и лаконичное, так как ориентировано, как правило, на оперативное освоение;
  • Избегать антропоморфных выражений в отношении технических средств. Система не может ничего «понимать», «изучать» или «ожидать»;
  • Использовать наглядные средства подачи информации, такие как блок-схемы, диаграммы, примеры и т.д.;
  • Документация не должна вводить в заблуждение, должна быть актуальной. В документе недопустимы неточные сведения.
В заключении хотелось бы обратить внимание на то, что при написании пользовательской документации нужно помнить, для кого разрабатывается документ и будет ли необходимость в авторе, чтобы объяснить написанное.

@ Ирина Мигачева