Структурируйте

Грамотно выстроенная структура текста помогает быстрее считывать содержание. Облегчить восприятие помогут:

• понятные заголовки и подзаголовки;
• маркированные списки и таблицы для перечислений или однородных членов — точно как текст, который вы читаете сейчас;
  
• выделение ключевых слов и фраз;
  
• вставки с примерами и сравнениями.
  

Если можно — визуализируйте

Что лучше запоминается — текстовое описание системы или её короткая блок-схема? Иллюстрации не просто хорошо дополняют текст, а часто могут заменить его. Подумайте, может, ваше долгое техническое описание системы можно нарисовать?

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

Чем проще, тем лучше

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

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

Всегда помните про свою аудиторию: для кого вы пишете этот текст? Если для своего тимлида — можно добавлять термины и аббревиатуры, которые вам обоим понятны. Если для партнёра — без «котика» и других уменьшительно-ласкательных не обойтись. Если это текст для социальных сетей про вашу жизнь или ваши мысли, выбирайте слова, которые не требуют дополнительных объяснений. А если упомянули Vue.js и RxJS — поясните, что это. Удобно использовать сложный язык по привычке, но важно помнить, что «умные» слова должны быть понятны вашей аудитории.

Исследования учёных во главе с Дэниелом Оппенгеймером доказали, что авторы более простых текстов кажутся умнее. Полезное свойство!

Укорачивайте

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

Например:

Избегайте слов без смысла — «стоп-слов»

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

Создавайте действие через глаголы

Глаголы создают динамику и описывают процесс, который происходит в тексте. Активный залог вместо пассивного делает текст интереснее и энергичнее. Ещё он позволяет читателю чётко определить действие и его исполнителя.

Используйте субъект, выполняющий действие. В активном залоге субъект, который совершает действие, — это главный элемент предложения. Укажите явно, кто действует, чтобы избежать неопределённости и сделать текст более конкретным.

Например:

• «статья написана экспертом» — пассив;
• «эксперт написал статью» — актив.
  

Избегайте слабых глаголов вроде «быть» и старайтесь использовать те, что описывают физическое действие. Например:

• «идея была принята командой» — пассив;
• «команда приняла идею» — актив.
  

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

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

Аналогия с арендой сейфа позволяет легко понять, как работает облачное хранение данных, какие преимущества оно даёт и почему это удобный и безопасный способ хранения информации.

Резюмируем

• Структурировать: делить текст на абзацы и смысловые куски.
• Писать короткими предложениями.
  
• Использовать слова, понятные предполагаемому читателю.
  
• Забыть про модальные глаголы и вводные слова.
  
• Активный залог вместо пассивного.
  
• Избегать лишних слов («стоп-слов»).
  
• Визуализировать.