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