Редактирование для читателя — Примеры

Пример 1 — Удалите разминку и начните с инструкции

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

До
Этот документ описывает процесс возврата. Он предназначен для сотрудников
поддержки и призван охватить различные случаи, которые могут возникнуть.
По сути, это просто руководство по типичному потоку возврата. Учтите,
что политика может меняться со временем.

Решение

После
Верните оплату картой в течение 90 дней: Поддержка > Заказы > Возврат.
Возвраты на подарочную карту идут по маршруту согласования, не по этому.

Если возврат не проходит, повторите дважды, затем напишите финансам
с указанием номера заказа.

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

Пример 2 — Замените абстракцию конкретикой и проверьте на незнакомце

Раздел об обработке ошибок никого ничему не учит, потому что говорит прилагательными. Перепишите его шагами и значениями, затем дайте кому-то, кто не видел работы, и впишите его вопросы обратно.

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

Решение

Если загрузка не прошла, повторите трижды за 30 секунд.
Если снова не выходит, сохраните частичный файл и покажите
«Возобновить загрузку»; не отбрасывайте уже отправленное.

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

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