Як писати інструкції Ясно

Зміст:

Anonim

Багато людей не читатимуть інструкції, крім як останньої інстанції. Коли люди читають їх, вони корисні, лише якщо вони написані чіткою, лаконічною мовою. Коли ви зрозумієте свою аудиторію, ви будете краще підготовлені для вступу, а потім до інструкцій.

Вивчіть свою аудиторію

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

Створіть вступ

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

Використовуйте Active Voice

Утримайтеся від використання пасивного голосу, наприклад, "Білий дріт повинен бути вставлений в пробку A." Замість цього напишіть інструкцію як команди, які вимагають активного голосу, наприклад, "Вставте білий дріт у роз'єм A." Якщо ви пишете список, наратив або буклет, розбивати довгі речення з кількома кроками на короткі інструкції, які перелічені під заголовками. Розбийте речення, які містять слово "і", у коротші окремі речення. Замість того, щоб писати “Кабель повинен бути зрощений і поміщений в червону розетку”, напишіть два речення, що починаються з дієслів дій, наприклад “Сплітайте кабель. Помістіть з'єднаний кабель у червону розетку. ”Ясний, сміливий заголовок міг сказати щось на кшталт“ Підключіть дроти ”.

Окремі дії з пояснювальної інформації

Дуже часто інструкції також потребують пояснень. Напишіть пояснювальні коментарі одним із двох способів. Виділити напівжирними фактичні інструкції, щоб вони виділялися, або надавати пояснення в окремій колонці для довідки. Однією з тактик є розміщення кроків на одній стороні документа, з поясненнями в короткій абзаці в стовпці поруч. Інший, більш ефективний спосіб полягає в тому, щоб сформулювати фактичні інструкції і завершити крок, написавши пояснення. Наприклад, “Натисніть червону кнопку протягом трьох секунд (виділено жирним шрифтом). Це дозволить активувати світло."