Что описать в запросе
Минимум — что за продукт и для кого инструкция. Дальше каждый факт убирает из текста по одной догадке.
- Тип продукта — программа, мобильное приложение, веб-сервис, устройство, производственное оборудование.
- Читатель — новичок, который включает впервые; опытный пользователь; администратор, который настраивает систему для других.
- Сценарии — три-пять задач, ради которых продуктом пользуются каждый день.
- Фактура — названия экранов и кнопок, пункты меню, системные требования, комплектность поставки.
- Объём — короткий быстрый старт на страницу или полное руководство с разделами и оглавлением.
Фактуру стоит выписать заранее, хотя бы коротким списком. Всё, чего нейросеть не знает про ваш продукт, она поставит в квадратные скобки с пометкой «уточнить», — и это лучше, чем выдуманный пункт меню, которого в программе нет.
Читателя полезно назвать честно. Инструкция для оператора на производстве и инструкция для менеджера, который открывает сервис из браузера, различаются не объёмом, а тем, что в них считается само собой разумеющимся.
Структура, которая работает
Порядок разделов в пользовательской документации давно устоялся, и ломать его незачем: читатель ищет нужное по привычным заголовкам.
| Раздел | Что внутри |
|---|---|
| Назначение | Какие задачи решает продукт и кому адресован документ |
| Что нужно для начала | Системные требования, доступы, комплектность, установка |
| Первый запуск | Путь от включения до первого полезного результата |
| Основные сценарии | Частые задачи, каждая — отдельной последовательностью шагов |
| Типичные проблемы | Симптом, причина, что сделать |
| Куда обращаться | Техподдержка, база знаний, условия гарантии |
Отдельная тонкость — с чего начинать. Хорошее руководство открывается не установкой, а коротким ответом на вопрос «что я отсюда получу»: два-три предложения про назначение продукта экономят читателю больше времени, чем любое оглавление.
Полное руководство дополняют оглавлением и словарём терминов, а для сложных продуктов добавляют раздел про настройку под себя. Редкие функции при этом уносят в конец, чтобы они не мешали основным сценариям. Короткому быстрому старту хватает трёх разделов — назначение, первый запуск и куда обращаться.
Шаг — это одно действие
Главное правило написания инструкций простое: один пункт — одно действие в повелительном наклонении, и рядом описан результат. Читатель должен видеть, что всё идёт правильно, не дочитывая документ до конца.
- Плохо: «Настройте параметры экспорта». Что нажать — неизвестно.
- Хорошо: «Откройте меню [название] и выберите пункт [название]. Откроется окно с настройками экспорта».
- Плохо: «Убедитесь в корректности подключения».
- Хорошо: «Подключите кабель к разъёму [название] до щелчка. Индикатор на корпусе загорится зелёным».
Проверка такая же, как у любого технического текста: по пункту понятно, выполнен он или нет. Если проверить нельзя — формулировку переписывают.
Стиль ровный и нейтральный, настоящее время, обращение на «вы». Никаких «легко и просто»: человек, который час ищет нужную настройку, читает такие слова как издёвку.
Ещё одна привычка хороших руководств — нумерация вместо маркеров там, где порядок обязателен. Список с точками читатель воспринимает как набор вариантов и спокойно делает пункты не по очереди.
Термины и скриншоты
Термин объясняется при первом упоминании — одной фразой в скобках или сноской, дальше его можно использовать свободно. Если таких слов больше десяти, их собирают в отдельный раздел-глоссарий.
Скриншот нейросеть не нарисует, но поставит метку вида [скриншот: окно настроек экспорта с выделенным полем «Формат»]. По таким пометкам понятно, какие кадры снять и куда их вставить, а описание картинки уже написано — останется подрезать подпись.
Пара мелочей оформления, которые заметно влияют на читаемость. Названия элементов интерфейса выделяют одинаково по всему документу — кавычками или полужирным, но не как попало. Шрифт для экранного чтения берут без засечек, а моноширинным набирают только то, что пользователь вводит с клавиатуры.
Раздел про проблемы читают чаще всего
Самый читаемый раздел — не первый, а тот, куда человек приходит, когда что-то не сработало. Пишут его по схеме из трёх частей: что видит пользователь, почему так вышло, что сделать.
- Симптом — формулировкой пользователя, а не разработчика. Человек ищет «не сохраняется файл», а не «ошибка записи в хранилище».
- Причина — одной строкой, без разбора внутренностей системы.
- Решение — теми же шагами, что и в основной части, с проверяемым результатом.
Сюда же выносят тексты ошибок дословно: по ним ищут и внутри документации, и в поисковике. Если полного списка ошибок нет, возьмите три-пять самых частых обращений в поддержку — они закроют большую часть звонков.
ГОСТ или свободная форма
Для внутренних продуктов и коммерческих сервисов формат свободный, и важно тут одно — чтобы человек нашёл ответ за минуту. Требования стандартов серий 19 и 34 всплывают на госзаказе, в тендерах и при сдаче системы на приёмку: там состав разделов и оформление документа проверяют формально.
Если ваш случай такой, скажите об этом в запросе — структура будет ближе к отчётной. Точных номеров пунктов стандарта в тексте не появится: сверять их нужно по действующей редакции, а не по памяти нейросети.
Чего в документе не будет
Выдуманной фактуры. Названия кнопок, пункты меню, версии операционных систем и минимальные требования конкретных программ нейросеть не придумывает — на их месте останутся квадратные скобки с просьбой уточнить. Выглядит менее нарядно, зато инструкция не отправит человека искать кнопку, которой нет.
Не будет и нормативных указаний по электробезопасности, работе под напряжением и обращению с опасным оборудованием. Такие требования берут из паспорта изделия и правил эксплуатации, а не из сгенерированного текста.
И третье: руководство не заменяет техподдержку производителя. Раздел «куда обращаться» в нём есть именно поэтому — часть проблем закрывается только на стороне вендора.
Как проверить готовое руководство
Черновик всегда кажется понятным автору: он знает продукт и мысленно достраивает пропущенные шаги. Поэтому проверяют не чтением, а прохождением.
- Отдайте инструкцию человеку, который продукт не видел. Пусть выполняет буквально, без подсказок. Каждая заминка — место, где шаг пропущен.
- Пройдите сценарии сами с чистой установки. На настроенной машине половина подготовительных действий уже сделана, и в текст они не попадут.
- Сверьте названия с интерфейсом. После любого редизайна первыми расходятся подписи кнопок и пункты меню.
- Убедитесь, что каждый шаг заканчивается результатом. Пункт без результата читатель выполнит и не поймёт, получилось ли.
Найденные расхождения правят сразу, а дату обновления ставят в начале документа — по ней читатель понимает, насколько текст свежий.
Чем это отличается от соседних карточек
Слово «инструкция» в каталоге встречается дважды, и путать их не стоит. Должностная инструкция — кадровый документ про обязанности, права и ответственность сотрудника. Здесь — руководство по работе с продуктом, и адресовано оно тому, кто этим продуктом пользуется.
Рядом есть карточка «Объяснить тему»: она разбирает понятие простыми словами, без шагов и без привязки к конкретной программе. А если нужен короткий текст про возможности продукта для карточки в магазине, это ближе к описанию товара.
Зачем это продукту
Понятное руководство снимает часть нагрузки с поддержки: вопросы про первый запуск и базовые настройки закрываются ссылкой на раздел. Процесс внедрения идёт быстрее — новый сотрудник проходит сценарии сам, без наставника рядом.
Есть и репутационный эффект. Пользовательская документация — часто первый текст, который человек читает после покупки, и по ней он судит, насколько аккуратно сделан сам продукт. Инструкция, написанная за один вечер и ни разу не обновлённая, заметна сразу.
Второй прикладной эффект — обучение. Готовое руководство становится основой для базы знаний и внутренних регламентов: текст уже разбит на сценарии, остаётся разложить его по отдельным статьям.
Поэтому руководство стоит держать живым: после каждого крупного обновления интерфейса проходить по шагам заново и править расхождения. Создание первой версии — самая долгая часть, дальше правки занимают полчаса.