Как правильно формулировать пошаговые действия пользователя в документации?

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

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

Небольшая справка по теории.

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

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

При описании прямых указаний используются глаголы 2-го8 лица множественного числа повелительного наклонения.

Сравните два варианта:

  • “Открой отчёт” (2-е лицо единственное число);
  • “Откройте отчёт” (2-е лицо множественное число).

Второй вариант всё-таки более “уважительный”.

Изъявительное же наклонение используется при возникновении пересечений с другой ролью. Например, если в инструкцию пользователя требуется включить шаг по взаимодействию пользователя с администратором.

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

Первая часть предложения обозначает действие пользователя, для которого разработана инструкция. Вторая часть отображает действие “смежной” роли в рамках одного процесса.

Итак, никаких “Переходим в раздел А и нажимаем на кнопку Б”.

При описании действий только повелительное наклонение в “уважительном” множественном числе - “Перейдите в раздел А и нажмите на кнопку Б”.