Содержание
Инструкции по эксплуатации являются отличным приложением в области технического письма. Хорошее руководство по эксплуатации расскажет пользователю обо всем, что ему нужно сделать, чтобы иметь возможность эффективно и безопасно выполнять поставленную задачу.
направления
-
Определите людей, которым будет поручено задание, и напишите об их уровне понимания. Знание вашей целевой аудитории является ключевой частью в технике письма.
-
Напишите резюме на лицевой стороне руководства, если оно будет содержать более нескольких страниц. Если руководство слишком длинное, включите указатель на обороте.
-
Напишите краткое введение, которое описывает задачу в качественном выражении. Дайте пользователю представление о задаче и каков будет конечный результат. Эту возможность следует использовать для предоставления важных советов, которые помогут пользователю правильно и эффективно выполнять работу.
-
При необходимости, предоставьте список соответствующего оборудования и предметов, которые потребуются пользователю для выполнения задачи. Если ваша инструкция по сборке продукта и сопровождает продукт, который будет собран, включите отдельный список всех частей, которые должны были быть предоставлены пользователю.
-
Четко укажите любой значительный риск, который может привести к травме, смерти, повреждению имущества и другим опасностям. Используйте соответствующий язык с законами того места, где будет продаваться руководство.
-
Запишите каждое действие оператора в отдельном шаге, предоставив всю информацию, необходимую пользователю для выполнения этого шага. Письмо должно быть буквальным, прямолинейным и не может быть неоднозначным.
-
Если в вашем руководстве есть место, включайте цифры и диаграммы каждый раз, когда вы выполняете трудный шаг для пользователя.
-
При необходимости создайте и включите список советов, которые помогут пользователю выполнить задачу.