Выбор сайта / Блог ontech.pro
Что включить в инструкцию по управлению сайтом
Инструкция по сайту не должна повторять всю справку системы управления. Её задача — помочь конкретному сотруднику выполнить конкретную работу в вашей конфигурации. Чем ближе документ к обычным операциям компании, тем меньше зависимость от разработчика при каждом небольшом изменении.
Подготовила команда ontech.pro · · 3 мин чтенияВыберите действия по частоте и последствиям
Соберите список операций, которые команда действительно выполняет: обновление цены, публикация материала, замена фотографии, проверка заявки. Для каждой определите пользователя и необходимый уровень доступа. Редкие сложные настройки можно вынести в отдельный технический документ.
Начните с действий, где ошибка заметна клиенту или влияет на продажи. Полная инструкция по управлению фоновыми цветами менее срочна, чем порядок снятия завершённой акции. Не измеряйте качество документа числом страниц: небольшое руководство по основным задачам часто полезнее неподъёмного описания всех разделов.
Опишите подготовку и ожидаемый результат
Перед шагами укажите, что должно быть готово: согласованный текст, изображение нужного назначения, актуальная цена. Затем назовите результат: посетитель видит новую информацию на определённой странице. Такой порядок помогает сотруднику понять, можно ли уже начинать операцию.
Используйте реальные названия элементов интерфейса и короткие скриншоты, если без них трудно найти действие. На изображениях не должно быть паролей и лишних клиентских данных. Один шаг должен содержать одно понятное действие. Не пропускайте переходы, очевидные автору инструкции, но неизвестные новичку.
Включите проверку после изменения
Публикация не заканчивается нажатием кнопки сохранения. Укажите, какую страницу открыть, что проверить на телефоне и где убедиться в доставке тестовой заявки. Если содержание повторяется в нескольких местах, перечислите их. Сотрудник должен знать, что цена может присутствовать и в карточке, и в отдельном блоке.
Для безопасного возврата опишите доступный порядок восстановления прежнего содержания. Не обещайте универсальную кнопку отмены, если в вашей системе её нет. Рядом с массовыми операциями укажите, когда нужна резервная копия или участие специалиста. Инструкция должна отражать реальные возможности установленного решения.
Добавьте типовые ошибки и границы
Полезны короткие разборы: изображение обрезалось, ссылка ведёт не туда, изменение не видно посетителю, форма не отправляется. Для каждого опишите безопасную первичную проверку и момент обращения в поддержку. Не включайте случайные технические команды, последствия которых сотрудник не понимает.
Отдельно обозначьте действия вне полномочий: изменение платёжных настроек, удаление пользователей, установка расширений. Покажите маршрут согласования. Это не запрет на самостоятельность, а ясное распределение ответственности. Секреты и платёжные данные не должны храниться внутри общей инструкции или на её скриншотах.
Сделайте документ живым рабочим инструментом
Разместите инструкцию там, где её легко найти, и укажите владельца, дату проверки и применимую версию интерфейса. Ссылка на помощь в рабочем разделе часто полезнее файла, однажды отправленного в чат. После изменения сайта обновляйте соответствующий сценарий, а не переписывайте весь документ без необходимости.
Проверьте руководство на сотруднике, который не участвовал в разработке. Дайте ему обычную задачу и наблюдайте, где приходится спрашивать. Эти места стоит исправить в тексте. Сохраняйте частые вопросы как дополнения: инструкция должна постепенно уменьшать зависимость от памяти отдельных людей и поддерживать единый порядок работы.