Блог технического писателя Ильи Жукова

Книга «Пиши, сокращай: как создавать сильный текст»

Наводя порядок в книжном шкафу, нашел книгу Максима Ильяхова и Людмилы Сарычевой «Пиши, сокращай: как создавать сильный текст». Я прочитал ее летом 2018 года, но отзыв для блога писать не стал. Сегодня, когда ажиотаж отзывов прошёл, кратко расскажу, какие советы из книги можно применить для работы над текстом пользовательской документации.

кгина о создании сильного текста "Пиши, сокращай: как создавать сильный текст""

Книга «Пиши, сокращай: как создавать сильный текст» посвящена работе с нехудожественными текстами. В ней описывается методика освоения информационного стиля. В основу информационного стиля положены работы Норы Галь «Слово живое и мертвое», Корнея Чуковского «Живой как жизнь», а также редакторская практика авторов. На примерах показано, как получить краткий, честный и объективный текст. В последней главе подробно разобрано, как написать сопроводительное письмо / отклик на вакансию и текст о себе / своей компании / продукте / услуге.

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

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

К разработке текста пользовательской документации эта методика применима в части работы на уровне слов, предложений и абзацев. Сокращать и упрощать текст пользовательской документации нужно, чтобы она была ясной и понятной. Хорошо структурированный текст можно быстро просмотреть и найти нужную информацию. «Легко понять» и «легко найти» — 2 основных критерия оценки качества пользовательской документации. Но для пользовательской документации информационный стиль полностью не подходит из-за субъективности предлагаемой методики. То, что понятно и честно для одного, может быть не понятно и не честно для другого.

Я ежедневно применяю на практике следующие советы, приведенные в книге:

  • Сокращаю в тексте всё ненужное.
  • Читаю текст вслух много раз; переписываю всё, на чем спотыкаюсь.
  • Подкрепляю текст иллюстрациями – снимками экрана.

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

 

Добавить комментарий

Последние статьи

Создание CHM-справки в бесплатной програ…

KEL CHM Creator — это «новая» хорошо забытая программа, выпущенная в 2012 году, предназначенная для создания и декомпиляции CHM-файлов. Программа не требовательна к ре...

Читать полностью...

KEL CHM Creator — бесплатная программа д…

Если вам нужно создать CHM-файл, и вы больше не хотите пользоваться глючной программой HTML Help Workshop, тогда KEL CHM Creator — это ваш вариант. Программа позволяет...

Читать полностью...
ключевые слова

Ключевые слова в Help+Manual

Предметный указатель — это список ключевых слов (терминов, основных понятий и т.п.), помогающий читателю быстро найти в документе нужную информацию. В печатной докумен...

Читать полностью...

HTML Help Workshop – бесплатная программ…

В 1997 году Microsoft выпустила новый формат справки, HTML Help (CHM), а также бесплатную программу для создания и редактирования справки в этом формате — HTML Help Wo...

Читать полностью...

HelpNDoc — бесплатная альтернатива Help+…

Еще одной альтернативой RoboHelp и Help&Manual является программа HelpNDoc от французского разработчика, компании IBE Software. Это практически полный аналог HelpS...

Читать полностью...

HelpSmith — достойная альтернатива Help+…

Продолжая тему средств разработки справки и пользовательской документации, нельзя не рассказать о программе HelpSmith. Она работает по принципу единого источника и под...

Читать полностью...
отечественная программа для разработки справки

Dr.Explain — отечественная программа для…

За почти 30-летнюю историю существования RoboHelp и Help&Manual стали стандартом средств разработки справки и пользовательской документации в среде Windows. Сегодн...

Читать полностью...
вычитка текста

Как вычитать свой текст: инструкция для …

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

Читать полностью...
качество текста

Как повысить качество текста инструкций

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

Читать полностью...

Закон построения нехудожественного текст…

Вы не задумывались, почему некоторые тексты читаются на одном дыхании, а через другие приходится продираться? Почему одна статья запоминается на лету, как бы сама собо...

Читать полностью...

Примечания и предупреждения в тексте инс…

Важную информацию в тексте можно выделять по-разному. Можно целые предложения оформлять жирным, подчеркнутым и курсивным шрифтом. Можно написать все слова в предложени...

Читать полностью...

Методика чтения научных книг

Я не люблю брать в руки разрисованные книги. Текст исчиркан, подчеркнут, зачеркнут. Ручкой, карандашом, маркером. Уголки страниц загнуты. На полях рукописные пометки, ...

Читать полностью...

Как починить поиск в русском PDF

Начинающий пользователь Help+Manual, пишущий документацию на русском языке, рано или поздно сталкивается с ситуацией, когда в созданном PDF-документе не работает поиск...

Читать полностью...

Что нового в Help+Manual 8

10 февраля 2020 года вышла 8-я версия Help+Manual. Любой желающий может бесплатно скачать пробную версию с сайта компании-разработчика и оценить ее потенциал. В течени...

Читать полностью...

Работа со стилями в Help and Manual 7

Чтобы внешний вид нового CHM-файла соответствовал оригиналу, необходимо создать стили, применить их к проекту и очистить встроенное форматирование. Это позволит обеспе...

Читать полностью...

Форматы справки для ОС Linux

В рамках замещения импортного программного обеспечения все больше государственных структур переходят на отечественные сборки Linux. Прежде всего, это Alt Linux и Astra...

Читать полностью...

Все о справке и документации для пользователей!

Следить за новыми статьями:

© Илья Жуков, 2019-2022. Охраняется законом об авторском праве.