Наводя порядок в книжном шкафу, нашел книгу Максима Ильяхова и Людмилы Сарычевой «Пиши, сокращай: как создавать сильный текст». Я прочитал ее летом 2018 года, но отзыв для блога писать не стал. Сегодня, когда ажиотаж отзывов прошёл, кратко расскажу, какие советы из книги можно применить для работы над текстом пользовательской документации.
Книга «Пиши, сокращай: как создавать сильный текст» посвящена работе с нехудожественными текстами. В ней описывается методика освоения информационного стиля. В основу информационного стиля положены работы Норы Галь «Слово живое и мертвое», Корнея Чуковского «Живой как жизнь», а также редакторская практика авторов. На примерах показано, как получить краткий, честный и объективный текст. В последней главе подробно разобрано, как написать сопроводительное письмо / отклик на вакансию и текст о себе / своей компании / продукте / услуге.
Отвечая на вопросы «Как писать?» и «О чем писать?», авторы рассказывают, как работать с текстом на следующих уровнях по принципу «от малого к большому»:
- На уровне слов: сокращать, удалять всё ненужное.
- На уровне предложений: упрощать, чтобы они легко читались.
- На уровне абзацев: делить текст на абзацы, убирать лишние предложения, добавлять заголовки в начале абзацев, чтобы читатель мог быстро найти нужную информацию.
- На уровне структуры текста и логики изложения: группировать информацию, добавлять заголовки и подзаголовки.
- На уровне смыслов: о чём писать.
К разработке текста пользовательской документации эта методика применима в части работы на уровне слов, предложений и абзацев. Сокращать и упрощать текст пользовательской документации нужно, чтобы она была ясной и понятной. Хорошо структурированный текст можно быстро просмотреть и найти нужную информацию. «Легко понять» и «легко найти» — 2 основных критерия оценки качества пользовательской документации. Но для пользовательской документации информационный стиль полностью не подходит из-за субъективности предлагаемой методики. То, что понятно и честно для одного, может быть не понятно и не честно для другого.
Я ежедневно применяю на практике следующие советы, приведенные в книге:
- Сокращаю в тексте всё ненужное.
- Читаю текст вслух много раз; переписываю всё, на чем спотыкаюсь.
- Подкрепляю текст иллюстрациями – снимками экрана.
Думаю, что книга будет полезна всем, кто пишет нехудожественные тексты: студентам, журналистам, копирайтерам, авторам блогов и рассылок.