Как написать инструкцию с нуля

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

Шаги

1. 1 Укажите тему. Будьте точны в ее границах и сфере.
2. 2 Определите, для кого готовится инструкция.
   • Вы пишите для новичков, профессионалов или для кого-то со средними знаниями?
   • Вашу инструкцию будут использовать на групповых занятиях или для самостоятельного изучения?
3. 3 Точно определите, о чем будет сказано в инструкции.
   • Пример: Вы готовите руководство «Как установить двери». Один раздел может быть посвящен дверям-купе, другой – входных дверям, еще один – дверям для черного входа.
4. 4 Решите, какая логическая структура изложения материала подойдет лучше всего. Взаимосвязь разделов относится не только к последовательности действий. Иногда вначале необходимо включить раздел с описанием некоторых терминов и понятий, а также лучше описать задания, повторяющиеся в разных разделах. Но если вы предполагаете, что читатель уже имеет определенные навыки для выполнения задания, описания общих процедур лучше привести в приложениях.
5. 5 Если в инструкции используется профессиональная терминология или жаргон, нужно подготовить словарь терминов. Если знание читателями терминологии маловероятно, глоссарий лучше поместить сразу после содержания. Обновляйте список терминов по мере написания инструкции.
   • В глоссарии нужно использовать максимально точные описания терминов. Если используется акроним, объясните его значение (например, Scuba – «Self Contained Underwater Breathing Apparatus» автономный аппарат подводного дыхания).
6. 6 Решите, какие темы требуют дополнительного исследования. Если инструкция подготовлена некачественно, она бесполезна. Предварительные исследования нужно завершить до того, как вы приступите к написанию инструкции.
7. 7 Подумайте об организационной структуре каждого раздела.
   • Пример: Вы готовите инструкцию об определенных компьютерах. В этом руководстве может быть раздел «Устранение проблем». Часть материала в нем можно посвятить проблемам с дисковым пространством, другую – чрезмерному использованию оперативной памяти и т.д.
8. 8 Организуйте каждый раздел и секцию в логической последовательности, сужая границы каждой темы.
9. 9 Приступайте к написанию! Используйте организационную систему, как основу, но можете смело модифицировать ее, чтобы полнее раскрыть тему.
   1. Напишите описание разных заданий.
   2. Подготовьте примеры, выполняя которые читатель лучше поймет инструкцию.
   3. Подготовьте соответствующие иллюстрации. Не вставляйте рисунки, пока инструкция не написана. Иллюстрации необходимо подогнать под размеры текста.
   • Внесите изменения, чтобы облегчить читателю поиск необходимой информации.
     
     1. Пример 1: (Используйте нумерованный список) В редакторе можно привязать рисунок к пункту 13-му параграфу инструкции.
        
     2. Пример 2: (Сортировка) В редакторе можно увеличить размер текстовой строки, если она выделяется из общего порядка.
10. 10 Не списывайте чужие инструкции! Используйте указатели и список литературы, указывая, откуда заимствована цитируемая информация (другие авторы, инструкции и т.д.).
    • Ничто не разрушает доверие к автору быстрее, нежели плагиат. Подумайте, что бы вы чувствовали, когда кто-то «украдет» часть вашей работы для своей инструкции?
11. 11 Добавьте соответствующие иллюстрации. Расположите их в тексте. Не бойтесь оставлять пустое пространство.
12. 12 Проверьте, проверьте и еще раз проверьте. Поиск ошибок должен быть постоянным. Делайте заметки об обнаруженных ошибках или упущенной информации. Исправляйте их. Отметьте параграфы, которые кажутся непонятными другим людям. Перепишите эти места заново, чтобы облегчить понимание. Дайте разным людям прочесть вашу инструкцию, чтобы удостовериться в том, что она написана наилучшим образом.
    • • Лучший, по нашему мнению, порядок проверки готовой инструкции:
        1. Вычитайте ошибки самостоятельно.
        2. Попросите друга проверить ошибки.
        3. Дайте работу на проверку специалисту в данной области, чтобы он также проверил ее.
        4. Если инструкция готовится для вашей компании, попросите начальника проверить ее.
        5. Дайте работу на проверку новичку.
        • Проверка неопытным специалистом поможет понять, насколько понятно изложен текст для людей, у которых в данной области минимум знаний.

Советы

• Убедитесь, что на титульной странице и в нижнем колонтитуле каждой страницы указана ваша фамилия, как автора руководства. Распечатайте копии инструкции до того, как отсылать ее по электронной почте. Включите знак копирайта (с) в нижнем колонтитуле. Можете набрать (с), и большинство текстовых редакторов автоматически исправит это на нужный символ. В результате нижний колонтитул будет выглядеть «© Ваше Имя». Это не помешает компании копировать инструкцию, но вы сохраните свое авторство.