Як написати навчальний посібник
Навчальний посібник являє собою збірник (книгу) інструкцій. Посібник призначений для забезпечення огляду теми перед заняттями в класі, конспекту для занять під час навчального курсу, предметної посилання для подальшої підготовки і загальної посилання. Використовуйте ці кроки для написання навчального посібника.
Кроки
1
Дізнайтеся свою аудиторію. Досліджуйте рівень знань і досвід вашої аудиторії, розглядаючи сервіс, систему або продукт адрес навчального посібника.- Використовуйте просту мову і надайте велику систему або довідкову інформацію про продукт за змістом для нових груп. Нові користувачі повинні не тільки дізнатися про продукт або системі, але як їх використовувати.
- Використовуйте термінологію більш високого рівня і менше довідкової інформації для груп, які знайомі з продуктом або системою. Існуючим користувачам системи або продукту, можливо, потрібно знати про нові доданих функціях.
2
Напишіть план. Схема допомагає організувати інформацію. Вона також допоможе вам переконатися, що всі пункти системи або продукту розкриті в навчальному посібнику.
3
Почніть з орієнтування. Окресліть структуру компанії, ролі та обов`язки. Уявіть стандартні операційні (робочі) процедури SOP, директиви та показники QA (контролю якості). Переглянете деякі загальні принципи коротко, можливо, через списки або за допомогою ключових слів. Взагалі, не думайте, що читач знає що-небудь про предмет або навіть організації та викладає речі ясно.- Дотримуйтеся короткої орієнтації і по суті. Перечитайте і відберіть всі непотрібні доповнення.
4
Напишіть глави уроку. Починайте кожну главу з огляду інформації, представленої на наступних сторінках. Використовуйте заголовки для організації інформації в менші розділи в кожному розділі.- Починайте кожен крок або напрямок з дієслова дії.
- Дотримуйтеся коротких директив і по суті.
Подавайте будь-яку довідкову інформацію в окремих полях для відміток, щоб тримати всі разом і допомогти користувачам бачити процес від початку до кінця.
1
- Попереджайте користувачів про будь альтернативному способі виконання кроків. Якщо існує більше 1 способу, щоб завершити дію, відзначте це в навчальному посібнику.
- Увімкніть скріншоти, якщо це припустимо. Скріншоти системи забезпечують наочне приладдя, яке доповнює текстові інструкції.
2
Складіть окремі зведені розділи уроків. Напишіть короткий огляд суті інформації, що міститься в кожному розділі. Використовуйте довідкові таблиці для будь-якої інформації, на яку, можливо, буде потрібно користувачам регулярно посилатися, наприклад, комбінації клавіш або визначення полів.- Вставте підсумкові розділи уроку після закінчення кожного розділу. Створіть додаток або розділ посилань в кінці керівництва і включіть там все резюме уроків.
3
Проведіть пробний тренінг. Виберіть групу учасників, яка нагадує групу, яка буде використовувати навчальний посібник кінцевого продукту. Нехай група використовує навчальний посібник і надати вам відгук про читабельність, областях для поліпшення і розділи, які потребують більш-менш докладному викладі.
4
Змініть інструкцію. Використовуйте зворотний зв`язок (відгуки), отриману від тестирующей групи, щоб внести зміни до змісту або достаток керівництва.- Надішліть інструкцію групі редакторів або співробітникам. Попросіть їх відкоригувати граматику і пунктуацію в навчальному посібнику.
Поради
- Увімкніть форму зворотного зв`язку (відгуків) в навчальний посібник. Користувачі навчального посібника можуть мати спосіб відправки будь-яких пропозицій або змін після занять у класі, або як документування системи або продукту в рамках змін посібники.
