Процедуры написания, часть 2: основы

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

Начальное предложение

В начальном предложении кратко описывается задача, которая выполняется посредством прохождения процедуры.

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

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

Пример:

Чтобы открыть файл, // В начальном предложении указывается задача.

Дважды щелкните значок. // Единственный шаг процедуры.

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

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

Пример:

//Здесь можно добавить описание задачи. «Выполненные задачи могут перегружать список задач и // рассеивать ваше внимание. Вы можете архивировать выполненные задачи, чтобы сохранить список задач информативным. Вы можете просмотреть архивированные задачи в разделе «Архив».

Чтобы архивировать задачу:

1. Перейдите на вкладку «Задачи».
2. Щелкните правой кнопкой мыши по названию задачи, чтобы открыть контекстное меню.
3. Выберите Архив.
4. Нажмите OK, чтобы подтвердить действие. Если задача успешно архивирована, ее статус изменится на Архивировано. Если произошла ошибка, вы увидите сообщение на экране.

Постоянно ведутся дискуссии о степени сходства в начальном предложении (должны ли слова типа «выполнить задачу»выполните следующие шаги/выполните следующие шаги). По моему мнению, они в основном просматриваются и не так важны для читателя, но они сильно влияют на голос. Так что, если вы запутались в форме начального предложения, попробуйте разные варианты и посмотрите, какой вариант лучше для ведения голоса. И убедитесь, что все процедуры начинаются одинаково во всем документе.

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

Этапы процедуры

Я рекомендую делать предложения в шагах максимально короткими. Каждый шаг должен содержать одно действие. Однако используйте немного эмпатии и внимания — иногда полезно добавить немного текста или описать варианты более подробно, особенно если процедура описывает необратимый или труднообратимый процесс.

Пример:

Чтобы архивировать задачу:

1. Перейдите на вкладку «Задачи».
2. Чтобы открыть контекстное меню, щелкните правой кнопкой мыши задачу.
3. Выберите Архив. Архивация задачи делает ее доступной только для чтения. Вы можете просмотреть архивированные задачи в разделе Архив.
4. Для одобрения действия нажмите OK. Если задача успешно архивирована, то ее статус изменится на Архивировано. Если произошла ошибка, вы увидите сообщение на экране.

Если действие действительно простое и очевидное, вы можете объединить такие действия в один шаг.

Пример:

Перейдите в Действия->Задачи -> Архивировано

Вместо того, чтобы описывать каждый шаг отдельно.

Если есть некоторая неопределенность, то, возможно, лучше разделить действия и предоставить некоторые подробности по каждому шагу.

Для необязательных шагов может быть полезно предоставить примечание или описать шаг таким образом, чтобы он был необязательным.

Пример:

1. (необязательно) Отметьте задачу как важную, чтобы переместить ее в начало списка.
2. Вы можете отметить задачу как важную, чтобы переместить ее в начало списка.

Если у шага есть два разных пути, четко укажите, что пользователь должен выбрать один из них.

Пример:

Вы можете позвонить одним из следующих способов:

• Нажмите «Позвонить».
• Дважды щелкните по фотографии пользователя.

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

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

Описания шагов и предупреждения делают шаг более подробным и привлекают внимание. Они не должны быть отделены от шага, но вы можете начать их с новой строки. Сделайте это последовательным, добавив правила в руководство по стилю.

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

Четкое указание результата

Зачем читать процедуру? Чтобы получить результат. Это значит, что результат должен быть очевиден. Иногда интерфейс не указывает четко, что пользователь выполнил задачу. Иногда результат может отличаться. Процедура должна быть завершена предложением, описывающим явный положительный результат — как пользователь узнает, что задача выполнена:

• Успешно – цель, заявленная в начальном предложении, достигнута.

• Безуспешно – в этом случае лучшим вариантом будет предоставить подробную информацию в сообщении об ошибке через UI. В противном случае напишите краткое описание, в чем причина и как ее исправить.

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