Як написати інструкцію з нуля: 15 кроків

Написання інструкцій щодо виконання певних функцій покаже керівництву на роботі ваші здібності. Така інструкція також підтвердить, що ви здатні виконати проект самостійно.

кроки

1. вкажіть тему. Будьте точні в її межах і сфері.

Зображення з назвою Write a Manual from Scratch Step 2

2. Визначте, для кого готується інструкція.

Ви пишіть для новачків, професіоналів або для кого-то з середніми знаннями?

Вашу інструкцію використовуватимуть на групових заняттях або для самостійного вивчення?

Зображення з назвою Write a Manual from Scratch Step 3

3. Точно визначте, про що буде сказано в інструкції.

Приклад: Ви готуєте керівництво «Як встановити двері». Один розділ може бути присвячений дверей-купе, інший - вхідних дверей, ще один - дверей для чорного входу.

Зображення з назвою Write a Manual from Scratch Step 4

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

Зображення з назвою Write a Manual from Scratch Step 5

5. Якщо в інструкції використовується професійна термінологія або жаргон, потрібно підготувати словник термінів. Якщо знання читачами термінології малоймовірно, глосарій краще помістити відразу після змісту. Оновлюйте список термінів у міру написання інструкції.

У глосарії потрібно використовувати максимально точні описи термінів. Якщо використовується акронім, поясніть його значення (наприклад, Scuba - «Self Contained Underwater Breathing Apparatus» автономний апарат підводного дихання).

Зображення з назвою Write a Manual from Scratch Step 6

6. Необхідно вирішити, які теми вимагають додаткового дослідження. Якщо інструкція підготовлена неякісно, вона марна. Попередні дослідження потрібно завершити до того, як ви приступите до написання інструкції.

Зображення з назвою Write a Manual from Scratch Step 7

7. Подумайте про організаційну структуру кожного розділу.

Приклад: Ви готуєте інструкцію про певні комп`ютерах. У цьому керівництві може бути розділ «Усунення проблем». Частина матеріалу в ньому можна присвятити проблемам з дисковим простором, іншу - надмірного використання оперативної пам`яті і т.д.

Зображення з назвою Write a Manual from Scratch Step 8

8. Організуйте кожен розділ і секцію в логічній послідовності, звужуючи межі кожної теми.

Зображення з назвою Write a Manual from Scratch Step 9

я. Приступайте до написання! Використовуйте організаційну систему, як основу, але можете сміливо модифікувати її, щоб повніше розкрити тему.

Напишіть опис різних завдань.

Підготуйте приклади, виконуючи які читач краще зрозуміє інструкцію.

Підготуйте відповідні ілюстрації. Не вставляйте малюнки, поки інструкція не написана. Ілюстрації необхідно підігнати під розміри тексту.

Внесіть зміни, щоб полегшити читачеві пошук необхідної інформації.
Приклад 1: (Використовуйте нумерований список) В редакторі можна прив`язати малюнок до пункту 13-му параграфу інструкції.
Приклад 2: (Сортування) В редакторі можна збільшити розмір текстового рядка, якщо вона виділяється із загального порядку.

Зображення з назвою Write a Manual from Scratch Step 10

10. Чи не списуйте чужі інструкції! Використовуйте покажчики і список літератури, вказуючи, звідки запозичена цитована інформація (інші автори, інструкції і т.д.).

Ніщо не руйнує довіру до автора швидше, ніж плагіат. Подумайте, що б ви відчували, коли хтось «вкраде» частина вашої роботи для своєї інструкції?

Зображення з назвою Write a Manual from Scratch Step 11

11. Додайте відповідні ілюстрації. Розмістіть їх в тексті. Не бійтеся залишати порожній простір.

Зображення з назвою Write a Manual from Scratch Step 12

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

Кращий, на нашу думку, порядок перевірки готової інструкції:

Вичитайте помилки самостійно.

Попросіть одного перевірити помилки.

Дайте роботу на перевірку фахівцеві в даній області, щоб він також перевірив її.

Якщо інструкція готується для вашої компанії, попросіть начальника перевірити її.

Дайте роботу на перевірку новачкові.

Перевірка недосвідченим фахівцем допоможе зрозуміти, наскільки зрозуміло викладено текст для людей, у яких в даній області мінімум знань.

Поради

Переконайтеся, що на титульній сторінці і в нижньому колонтитулі кожної сторінки вказана ваша прізвище, як автора керівництва. Роздрукуйте копії інструкції до того, як відсилати її по електронній пошті. Увімкніть знак копірайту (с) в нижньому колонтитулі. Можете набрати (с), і більшість текстових редакторів автоматично виправить це на потрібний символ. В результаті нижній колонтитул буде виглядати «© Ваше ім`я». Це не завадить компанії копіювати інструкцію, але ви збережете своє авторство.