Рекомендации по написанию руководства
-
Лучшие руководства получаются тогда, когда вы пишете о том, что сами проверили. Поэтому, если есть такая возможность, сами проделайте те шаги, о которых хотите написать в вашей инструкции.
-
Если ваше руководство разбито на этапы, старайтесь писать их в разных шагах. Это делает ваш гайд более наглядным.
-
Система сама нумерует шаги в руководстве. Дополнительно указывать номер шага не нужно.
-
Старайтесь объяснить последовательность действий так, чтобы любой человек мог их повторить. Желательно, чтобы каждый пункт гайда был простым и конкретным действием.
-
Guidoscope — это не энциклопедия, поэтому не нужно писать о подробностях, которые не ведут к цели вашего руководства. Лучше поставьте ссылку на статью, где есть дополнительная информация о предмете.
-
Если ваше руководство написано по мотивам статьи в интернете, хорошим тоном будет указание источника.
-
Помните, что ваши инструкции будут повторять другие люди — они должны остаться живыми и здоровыми. Обязательно напишите о технике безопасности.