2learn

Редактирование для читателя

Что это такое

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

Почему это важно

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

Ключевые идеи

Удалите первый абзац

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

До    «Этот документ описывает процесс возврата. Он предназначен
       для сотрудников поддержки и призван охватить разные случаи…»
После «Верните оплату картой в течение 90 дней: Поддержка > Заказы > Возврат.»

Одна мысль на предложение, и мысль — первая

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

Замените абстракцию примером

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

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

Уберите оговорки и расшаркивания

«В общем-то», «по сути», «просто», «очевидно», «разумеется», «заметим, что», «обратите внимание»: каждое из них добавляет слово и отнимает доверие у предложения, перед которым стоит. Удалите их и проверьте, что ничего не потерялось.

Проверьте на ком-то, кто не вы

Дайте документ коллеге и попросите выполнить по нему задачу, ничего у вас не спрашивая. Каждый заданный вопрос — дефект документа, и каждый стоит исправить навсегда.

Практика

Отредактируйте один документ дважды

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

Готово, когда: страница стала заметно короче и ни один факт при этом не потерян.

Проведите тест на незнакомце

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

Готово, когда: у вас есть список вопросов, и ответы на них вписаны обратно в документ.

Частые ошибки

  • Сохранённый абзац-разминка — до полезного содержимого читатель добирается позже; исправить: удалите первый абзац и проверьте, не потерялось ли что-то.
  • Обоснование перед инструкцией — действия читатель так и не найдёт; исправить: поставьте инструкцию первой.
  • Абстракции вместо примеров — по «обрабатывайте ошибки аккуратно» действовать нельзя; исправить: дайте конкретные шаги и значения.
  • Набивка оговорками — «просто» сообщает читателю, что он медлит; исправить: удалите оговорки.
  • Отсутствие проверки на читателе — автор читает то, что имел в виду; исправить: пусть кто-то пройдёт по документу, а вы запишите его вопросы.

Что читать дальше

Разобранные примеры

Файлы cookie аналитики ставятся только с вашего согласия. До вашего выбора ничего не загружается и никуда не отправляется.