Как я переписал инструкцию к компьютерной программе

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

Я установил Бизнес-пак на компьютер с Виндоусом и прошел все шаги установки, поэтому инструкция не высосана из пальца, а написана исходя из собственного опыта. Я записал все вопросы, которые возникали у пользователей и отталкивался от них в написании новой инструкции. Придумал структуру, отскриншотил и вставил каждый шаг и позаботился о вопросах, которые могут возникнуть у пользователя во время работы по инструкции.

Переписанная инструкция на моем сайте.

Структура

Начал с названия. Название — полезное действие инструкции. Показать, как настроить Бизнес-пак для совместной работы:

Разбил инструкцию на три смысловых шага и написал краткое содержание, чтобы пользователь понимал, что ему предстоит:

Ввёл в тему и описал проблему, которую решает инструкция. Работа в Бизнес-паке по очереди — узкое место:

Следом написал условие, необходимое настройки. При всей очевидности, о нём необходимо сказать, чтобы исключить настройку программы на компьютере, не подключённом к сети:

Иллюстрации

Лучше показать, чем написать. Человек сравнит картинки в инструкции и на компьютере и поймет, что делает правильно.

Внезапно установщик просит скачать ещё одну программу, но так надо. Картинка подтвердит правильность действий

Важные моменты выделял цветом, чтобы было понятно, о чём идет речь:

Забота

Считаю, что к заботе о человеке относится и объяснение смысла выполняемого им действия. Поэтому, в начале каждого шага я писал, зачем он нужен:

Для того, чтобы человек понимал, что он выполнил шаг, описание шага заканчивается условием, при котором шаг считается выполненным.

В конце привёл раздел с известными проблемами, с которыми столкнулись люди, когда выполняли инструкцию:

Если хотите, чтобы я переписал вам инструкции, пишите мне в Телеграм: @ivan_smirnov