Зміст
Інструкції з експлуатації є чудовим додатком у сфері технічного письма. Гарне керівництво з експлуатації буде повідомляти користувачеві все, що йому потрібно, щоб мати змогу ефективно та безпечно виконувати дане завдання.
Інструкції
-
Визначте людей, яким буде покладено завдання, і напишіть, думаючи про свій рівень розуміння. Знання вашої цільової аудиторії є ключовою частиною в техніці написання.
-
Напишіть резюме на передній частині посібника, якщо він буде містити більше декількох сторінок. Якщо інструкція надто довга, вкажіть індекс на задній панелі.
-
Напишіть короткий вступ, який описує завдання якісно. Дайте користувачеві уявлення про завдання і який кінцевий результат буде. Ця можливість повинна використовуватися для надання важливих порад, які допоможуть користувачеві виконувати роботу правильно і ефективно.
-
За необхідності надайте перелік відповідного обладнання та предметів, які користувачеві необхідно виконати. Якщо ваша інструкція по експлуатації призначена для складання виробу та супроводжує вироби, що збираються, включіть окремий список всіх деталей, які повинні бути надані користувачеві.
-
Чітко визначте будь-який значний ризик, який може спричинити травмування, смерть, пошкодження майна та інші небезпеки. Використовуйте відповідну мову із законами місця, де буде продаватися посібник.
-
Записуйте кожну дію оператора на окремому етапі, надаючи всю інформацію, яку користувач повинен буде виконати. Писання має бути буквальним, прямим до точки і не може бути неоднозначним.
-
Якщо у вашому посібнику є місце, укажіть малюнки та діаграми кожного разу, коли ви очистите важкий для користувача крок.
-
У разі необхідності створіть і вкажіть список порад, які допоможуть користувачеві виконати завдання.