Лена!

Понимаю ваше желание сделать текст интереснее, тем более, если работа кажется нудной. Но в инструкциях это может только навредить.

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

Поэтому первым делом рекомендую проверять инструкции на удобство — как читатель будет искать нужную информацию? Сколько времени у него отнимет поиск?

Например, мы готовим инструкцию для сотрудников поддержки в интернет‑магазине, пишем раздел о доставке:

Неудобно

Доставка

Если покупатель просит перенести, поменять способ или изменить адрес доставки, найдите заказ по номеру, перейдите в раздел «Доставка» и выберите соответствующее действие.

Удобно

Доставка

Перенести. Номер заказа → Доставка → Перенести дату или время

Изменить адрес. Номер заказа → Доставка → Изменить адрес

Поменять способ. Номер заказа → Доставка → Поменять способ

В первом случае найти конкретное действие сложно, приходится читать весь текст, а слова «соответствующее действие» путают. Во втором случае есть чёткая структура, легко найти нужное. Шаги повторяются, но это помогает быстро сориентироваться.

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

Еще одни способ сделать эту работу интереснее — писать более простым, расслабленным тоном, тем более, если вы пишете для своих коллег. Коллегам наверняка не надо официально и строго, им надо удобно и просто. Вот и попробуйте.

Формально

Доставка

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

Дружелюбно

Доставка

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

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

Ещё одна интересная задача — грамотно сверстать инструкцию. Об этом рекомендую почитать совет Артёма Горбунова.

P. S. Это был воскресный совет о редактуре текста. Присылайте вопросы

Текст, редактура и информационный стиль
Отправить
Поделиться
Запинить

Комментарии

Я заметила, что инструкции можно писать двумя способами. Первый вариант — это описывать, что делать: «настройте, подключите, введите пароль». Второй вариант — это когда пишут пример решения прикладной задачи: «допустим, у нас есть два сервера, и сейчас мы настроим между ними сеть». Это чем‑то напоминает обучающие ролики на Ютубе. Такой способ зачастую понятнее для читателя, особенно для сложных задач.

Ещё, когда пишешь инструкцию, часто замечаешь — она нужна просто потому, что система несовершенна. Инструкция — это костыль. Если улучшить интерфейс или бизнес‑процессы, она не понадобится. Когда технический писатель может передать свои замечания тому, кто отвечает за продукт, — это чудесно.

24 июня 2019

Инструкция — это отдельный жанр. Инструкция по своей сути должна быть ближе к юридическим документам: всё должно быть чётко сформулировано, без допускания каких‑то вариантов. Каждое наименование в инструкции должно относиться к конкретному предмету. Бесит, когда читаешь инструкцию и постоянно возникают вопросы: «А какая именно клавиша? А где — в меню или в списке?»

27 июля 2019

Рекомендуем другие советы