Как написать инструкцию сотрудникам

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

Начните с задачи сотрудника

«Работа с разделом заявок» мало говорит человеку, который впервые открыл приложение. «Как передать согласованную заявку исполнителю» сразу объясняет, зачем читать страницу. Название должно совпадать с тем, что сотрудник собирается сделать, а не с названием внутреннего модуля. Тогда инструкцию проще найти и легче понять, относится ли она к текущей ситуации.

Выберите один повторяющийся сценарий: зарегистрировать обращение, подготовить расчёт или выгрузить отчёт за нужный период. Если в документе начинается другая задача, вынесите её на отдельную страницу и дайте ссылку в нужном месте. Разобрать весь интерфейс за один раз обычно сложнее, чем довести одну рабочую операцию до понятного результата.

Подход Diátaxis к практическим руководствам тоже строится вокруг задачи читателя, а не устройства программы. Применительно к Вашему приложению это означает: объяснять нужные действия и решения, а технические подробности оставлять в отдельном справочнике. Руководство не должно требовать от сотрудника знания того, как разработчик назвал таблицу в базе.

Сразу определите читателя. Новичку может понадобиться пояснение, откуда взять номер обращения. Опытному сотруднику, который забыл порядок выгрузки, достаточно короткой последовательности. Если документ рассчитан на обе группы, оставьте основную процедуру компактной, а пояснения вынесите в отдельные небольшие блоки. Не заставляйте опытного коллегу каждый раз перечитывать вводный курс.

Эта работа начинается после выбора рабочего сценария. Если пока непонятно, какую задачу вообще стоит переносить в отдельный инструмент, сначала разберите, когда бизнесу нужно веб-приложение. Здесь наша цель уже другая: помочь сотруднику пользоваться выбранным решением в ежедневной работе.

Объясните, что нужно до первого шага

До последовательности действий напишите, с чего сотрудник начинает. Укажите нужную роль, исходные сведения, допустимое состояние записи и место работы: учебный стенд или рабочее приложение. Это избавляет от ситуации, когда человек доходит до середины инструкции и только тогда узнаёт, что нужное действие ему недоступно.

Например: «Для передачи нужна заявка с согласованным составом работ. У Вас должен быть доступ к назначению исполнителя. Если состав ещё уточняется, не передавайте заявку дальше». Это учебный пример процедуры, а не описание готовой функции Nazara. Названия ролей, состояний и кнопок нужно заменить теми, которые действительно есть в Вашем приложении.

Не включайте в инструкцию пароли, ключи доступа и настоящие клиентские сведения. Объясните, где сотрудник получает личный доступ и к кому обращается, если войти не получается. Общий документ с секретами быстро превращается в неудобный способ их раздачи: старые копии могут оставаться в чатах и на чужих устройствах.

Для примера подготовьте безопасную учебную запись. Она должна позволять увидеть необходимые действия, но не отправлять настоящее уведомление клиенту, не создавать реальный заказ и не менять рабочие остатки. Если безопасного режима нет, не предлагайте новичку экспериментировать в действующей системе. Согласуйте тренировку отдельно с ответственным за приложение.

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

Запишите действия и видимый результат

Пройдите выбранную операцию сами в текущей версии приложения. Записывайте шаги по ходу работы, а не по памяти. Для каждого шага укажите действие, нужные данные и то, что сотрудник увидит после выполнения. Если между шагами требуется решение, назовите условие выбора: без него процедура превращается в угадывание.

В руководстве Microsoft по пошаговым инструкциям предлагаются нумерованные процедуры и отдельные шаги для действий. Для рабочего документа полезно также точно называть элемент интерфейса. Вместо «нажмите там справа» напишите название кнопки; её положение может измениться на другом экране.

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

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

Отдельно назовите момент окончания. Закрытая вкладка не доказывает, что сведения сохранились, а надпись об отправке не всегда означает, что другой сотрудник принял задачу. Укажите проверяемое состояние: запись найдена повторно, необходимые поля сохранены, дальнейшая ответственность понятна. Если подтверждение требует отдельного действия коллеги, включите его в процедуру.

Разберите ошибки и момент остановки

Хорошая инструкция помогает не только в удачном сценарии. Выберите ошибки, с которыми сотрудник действительно может столкнуться: обязательное поле пустое, запись недоступна, подходящего значения нет в списке, подтверждение не появилось. Для каждой ситуации объясните допустимое действие и границу самостоятельного решения.

Не ограничивайтесь советом «попробуйте ещё раз». Если приложение могло сохранить данные, повторная отправка способна создать дубль. Сначала предложите проверить результат способом, предусмотренным системой. Если достоверно установить состояние нельзя, сотруднику нужен маршрут помощи, а не бесконечное повторение одного нажатия.

В обращении за помощью достаточно указать задачу, шаг инструкции, время и видимое сообщение об ошибке. Добавляйте снимок экрана только после проверки, что на нём нет лишних данных. Не просите переслать пароль или всю клиентскую базу. Опишите безопасный канал и ответственного так, чтобы сотруднику не приходилось искать их в старой переписке.

Если действие влияет на деньги, права или внешние сообщения, граница остановки особенно важна. Не превращайте краткую инструкцию в разрешение менять чужие сведения. Спорное решение принимает назначенный ответственный; документ помогает распознать ситуацию и передать её ему. Он не заменяет профессиональные правила Вашей работы.

Добавьте изображения только там, где они помогают

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

Сначала подготовьте учебные данные, затем сделайте снимок нужного состояния. Уберите контакты, переписку, ключи, адреса закрытых систем и сведения, которые не нужны для объяснения. Не рассчитывайте на маленький размер картинки: оригинал могут открыть отдельно. Если безопасный снимок подготовить нельзя, используйте текстовое описание.

Подпись должна объяснять, что проверить, а не повторять «экран приложения». Например: «После сохранения выбранный исполнитель отображается в карточке обращения». Такая подпись полезна только после фактической проверки этого поведения. Картинка с нарисованной галочкой не является доказательством, что операция действительно завершилась.

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

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

Попросите коллегу пройти задачу самостоятельно

Дайте инструкцию человеку, который не участвовал в её написании, и предложите выполнить выбранную задачу на безопасном примере. Объясните, что проверяете документ и приложение, а не его внимательность. Не подсказывайте следующий шаг сразу: иначе Вы оцените собственное сопровождение, а не самостоятельность инструкции.

В методике GOV.UK по наблюдению за пользователями задачи связывают с понятной целью и не раскрывают заранее способ решения. Здесь можно применить тот же принцип: назвать результат, предоставить инструкцию и наблюдать, в каких местах человеку не хватает информации. Разрешите задавать вопросы и отмечайте их.

Записывайте конкретное затруднение. «Непонятно» трудно исправить; «после сохранения сотрудник не понял, где проверить исполнителя» уже указывает на недостающий шаг. Различайте проблему текста, интерфейса и рабочих правил. Если никто не может объяснить, кого назначать на задачу, ещё один скриншот эту неопределённость не устранит.

После проверки исправьте найденное и повторите нужный участок. Не объявляйте всё приложение освоенным по одной удачной операции. Отдельно проверьте важную ошибку: сможет ли сотрудник распознать её, не продолжить рискованное действие и найти помощь. Число прочитанных страниц само по себе не подтверждает готовность к работе.

Для внутреннего учёта достаточно небольшой записи: какую задачу проверяли, с какой ролью, в какой версии приложения, где понадобилась помощь и что изменили. Не превращайте её в рейтинг сотрудников. Цель проверки проста: сделать следующий самостоятельный проход понятнее и безопаснее.

Назначьте владельца и порядок обновления

У инструкции должен быть человек, который отвечает за её актуальность. Укажите дату проверки и версию приложения или существенное изменение, после которого проходили сценарий. Не ставьте новую дату только потому, что документ открыли: читателю важно знать, когда проверяли сам порядок действий.

Определите, что запускает пересмотр: новое поле, переименованная кнопка, изменение роли, другой порядок согласования или новая ошибка. После изменения пройдите затронутый сценарий, замените устаревшие снимки и проверьте ссылки. Если старый порядок больше не работает, уберите его из основного места чтения, сохранив архив отдельно.

Храните одну понятную актуальную версию, а не несколько равноправных файлов «финал» в чатах. Сотруднику нужен устойчивый путь к действующему документу. Архив полезен для разбора прежней работы, но не должен выглядеть как другая подходящая инструкция. Коротко отмечайте изменения: что теперь делается иначе и кому это важно.

Для открытого материала можно рассмотреть MD Publisher. Но способ размещения не отменяет проверки содержимого и доступа. Внутренние процедуры, реальные рабочие данные и закрытые адреса не стоит публиковать по общедоступной ссылке. Выбирайте место хранения под допустимый круг читателей, а не только под удобство отправки.

Перед передачей проверьте готовый документ по короткому шаблону: задача и читатель; условия начала; последовательность действий; признак завершения; ошибки и помощь; дата проверки и владелец. Если хотя бы один пункт неизвестен, зафиксируйте пробел и уточните его до самостоятельной работы сотрудника.

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

Если Вы хотите упростить сам процесс, а не только объяснить сложный порядок на бумаге, опишите повторяющуюся задачу. Умная форма поможет начать такое обсуждение. Не нужно заранее придумывать все экраны: полезнее показать, где сотрудник теряет время, чего не понимает и какой результат должен получать.

Вопросы об инструкции сотрудникам

Можно ли заменить инструкцию записью экрана

Видео удобно для первого знакомства, но нужный шаг в нём бывает трудно быстро найти. Оставьте текстовый порядок действий и признаки результата, а ролик используйте как дополнение. После изменения интерфейса проверьте и запись, и текст: устаревшее видео может показывать уже неверный путь.

Нужно ли описывать каждую кнопку приложения

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

Как понять, что нужен не новый текст, а изменение интерфейса

Если люди снова путают одинаковые названия, не замечают результат или вынуждены помнить скрытое условие, запишите это как проблему приложения. Инструкция может временно объяснить обходной путь, но не должна скрывать неудобство. Решение о доработке обсуждайте отдельно с ответственным.

Что делать, если один сценарий различается для разных ролей

В начале укажите, для какой роли написана процедура. Общие действия можно оставить вместе, а различающиеся ветки явно отделить. Если различий много, подготовьте самостоятельные инструкции. Не предлагайте человеку повторять действия, которых нет в его разрешениях.

Как проверить редкую, но рискованную операцию

Согласуйте безопасный учебный пример и наблюдение ответственного. Не создавайте реальные платежи, сообщения или изменения прав только ради обучения. Если безопасно воспроизвести действие нельзя, это ограничение нужно явно учесть до допуска сотрудника к самостоятельной работе.

Когда считать инструкцию готовой к передаче

Когда текущий сценарий пройден, названия и изображения соответствуют приложению, результат можно проверить, а сотрудник знает, где остановиться и попросить помощь. Передача документа не означает завершения обучения всем операциям: каждая важная задача требует своей проверки.