Как написать учебное пособие

Учебное пособие представляет собой сборник (книгу) инструкций. Пособие предназначено для обеспечения обзора темы перед занятиями в классе, конспекта для занятий во время учебного курса, предметной ссылки для последующей подготовки и общей ссылки. Используйте эти шаги для написания учебного пособия.

Шаги

1. 1 Узнайте свою аудиторию. Исследуйте уровень знаний и опыт вашей аудитории, рассматривая сервис, систему или продукт адресов учебного пособия.
   • Используйте простой язык и предоставьте обширную систему или справочную информацию о продукте по содержанию для новых групп. Новые пользователи должны не только узнать о продукте или системе, но как их использовать.
   • Используйте терминологию более высокого уровня и меньше справочной информации для групп, которые знакомы с продуктом или системой. Существующим пользователям системы или продукта, возможно, нужно знать о новых добавленных функциях.
2. 2 Напишите план. Схема помогает организовать информацию. Она также поможет вам убедиться, что все пункты системы или продукта раскрыты в учебном пособии.
3. 3 Начните с ориентировки. Очертите структуру компании, роли и обязанности. Представьте стандартные операционные (рабочие) процедуры SOP, директивы и показатели QA (контроля качества). Пересмотрите некоторые общие принципы кратко, возможно, через списки или с помощью ключевых слов. Вообще, не думайте, что читатель знает что-нибудь о предмете или даже организации и излагает вещи ясно.
   • Придерживайтесь краткой ориентации и по существу. Перечитайте и отберите все ненужные дополнения.
4. 4 Напишите главы урока. Начинайте каждую главу с обзора информации, представленной на следующих страницах. Используйте заголовки для организации информации в меньшие разделы в каждой главе.
   • Начинайте каждый шаг или направление с глагола действия.
   • Придерживайтесь коротких директив и по существу.

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

1. 1
   • Предупреждайте пользователей о любом альтернативном способе выполнения шагов. Если существует больше 1 способа, чтобы завершить действие, отметьте это в учебном пособии.
   • Включите скриншоты, если это допустимо. Скриншоты системы обеспечивают наглядное пособие, которое дополняет текстовые инструкции.
2. 2 Составьте отдельные сводные разделы уроков. Напишите краткий обзор сути информации, содержащейся в каждом разделе. Используйте справочные таблицы для любой информации, на которую, возможно, потребуется пользователям регулярно ссылаться, например, комбинации клавиш или определения полей.
   • Вставьте итоговые разделы урока после окончания каждой главы. Создайте приложение или раздел ссылок в конце руководства и включите там все резюме уроков.
3. 3 Проведите пробный тренинг. Выберите группу участников, которая напоминает группу, которая будет использовать учебное пособие конечного продукта. Пусть группа использует учебное пособие и предоставить вам отзыв о читабельности, областях для улучшения и разделы, которые нуждаются в более или менее подробном изложении.
4. 4 Измените инструкцию. Используйте обратную связь (отзывы), полученную от тестирующей группы, чтобы внести изменения в содержание или изобилие руководства.
   • Отправьте инструкцию группе редакторов или сотрудникам. Попросите их откорректировать грамматику и пунктуацию в учебном пособии.

Советы

• Включите форму обратной связи (отзывов) в учебное пособие. Пользователи учебного пособия могут иметь способ отправки любых предложений или изменений после занятий в классе, или как документирования системы или продукта в рамках изменений пособия.