Связанность текста — Как писать классные тексты

Упрощайте синтаксис
Пишите предложениями разной длины
Не связывайте запутанные мысли
Убирайте врезки
Выводы и практические советы

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

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

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

Упрощайте синтаксис

Начнем с уровня предложений и вспомним. На этом уровне информация воспринимается лучше, если читатель не сталкивается с преградами.

А преград в тексте много, потому что по правилам грамматики мы должны использовать множество разных знаков препинания:

Запятые вокруг сложных союзов и после вводных слов
Тире или двоеточие между частями сложного предложения без союза
Знак вопроса при риторическом вопросе
Скобки для дополнения

При чтении мы спотыкаемся на каждом знаке препинания — это как пауза в речи. Посмотрим на таком примере:

Сравним метод перебора, а также метод бинарного поиска. Первое заметное отличие: в целом, бинарный поиск сложнее в реализации. Стоит ли писать такие сложные программы? Да, но только при условии, если мы ищем по массиву из ста элементов, а может и более. Если нужно искать в массивах, объем которых не очень большой, можно использовать метод перебора. Он будет работать со сравнимой скоростью (а в некоторых случаях — даже быстрее).

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

Обратим внимание, сколько здесь отрывков от одного знака препинания до другого. Эти отрывки называются синтагмы и обозначают один фрагмент смысла.

В тексте выше целых 16 синтагм. Попробуем сократить их количество и упростить формулировки:

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

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

Пишите предложениями разной длины

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

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

Посмотрим на примере. Здесь все предложения одной длины, читать вслух сложно:

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

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

Чтобы информация воспринималась лучше, поменяем длину предложений:

✅ Все сайты работают по одному и тому же архитектурному принципу: у них есть клиент и сервер, которые постоянно взаимодействуют друг с другом.
Взаимодействие всегда происходит по схеме «запрос-обработка-ответ».
Обработка запроса и ответа — это рутинная задача для сервера.
Поэтому в программировании существуют разные полезные библиотеки, которые абстрагируют в себе основную работу с запросами и ответами.

Теперь информация подается динамичнее, потому что предложения разной длины: длинное, короткое, короткое, длинное.

Не связывайте запутанные мысли

Часто запутанные мысли можно отследить по оборотам:

«Стоит упомянуть»
«Обратите внимание»
«Важно уточнить, что»

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

⛔ Логика работы систем логирования достаточно проста:

1. Логика проста потому, что…
2. Логика проста потому, что…

Еще стоит упомянуть такое понятие, как трассировка — это присвоение…

Логи в системе логирования обычно хранятся с определенной структурой…

Такая структура путает студента и переключает его в режим многозадачности. Ему приходится перескакивать с темы на тему. В таком формате он хуже усвоит логирование и ничего не запомнит о трассировке.

Решить это проблему можно двумя способами:

Способ 1. Удалить абзац, если он не помогает понять основную тему:

✅ Логика работы систем логирования достаточно проста:

1. …
2. …

Логи в системе логирования обычно хранятся с определенной структурой…

Способ 2. Подробнее объяснить, почему мы вставляем абзац с дополнительной информацией:

✅ Логика работы систем логирования достаточно проста:

1. …
2. …

Отследить эту логику проще, если знать trace id — это уникальный идентификатор каждого лога. Присвоение такого trace id называется трассировкой…

Логи в системе логирования обычно хранятся с определенной структурой…

Иногда фраза «Обратите внимание на» не указывает на проблемы в структуре урока. Ее можно использовать, если мы указываем на конкретные подробности во фрагменте кода, на схеме или в теории:

✅ При этом кортеж может состоять из всего одного элемента. Обратите внимание на запятую в примере ниже — ее нужно ставить даже после единственного элемента кортежа:

tuple = (42,)

Убирайте врезки

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

Тогда автор делает врезку:

Логика работы систем логирования достаточно проста:

Логика проста потому, что…
Логика проста потому, что…

ПРИМЕЧАНИЕ: Еще стоит упомянуть такое понятие, как трассировка — это присвоение…

Логи в системе логирования обычно хранятся с определенной структурой…

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

Выводы и практические советы

В этом уроке мы изучили несколько советов по связанным текстам:

Упрощайте синтаксис. Старайтесь распутать мысль так, чтобы в ней было меньше синтагм — отрывков от одного знака препинания до другого. Чем меньше в тексте знаков препинания, тем легче читателю воспринимать вашу мысль
Читайте свой текст вслух. Так вы заметите отрывки с одинаковой длиной предложений, и сможете исправить эту проблему. После этого студенту будет проще читать и воспринимать текст
Отслеживайте в своем тексте фразы «Стоит упомянуть», «Обратите внимание» и «Важно уточнить, что». Эти фразы часто скрывают запутанную мысль
Не используйте в тексте врезки с подписью «Важно!» или «ПРИМЕЧАНИЕ». Информация из такой врезки не воспринимается читателем и отвлекает его от основной мысли текста

Самостоятельная работа

Отредактируйте такой текст:

Обратная связь бывает позитивная и корректирующая, а также развивающая, когда руководитель задает вам вопросы. Если обратная связь вас расстроила или, например, вызвала желание защищаться, то не торопитесь сразу оправдываться.

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

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

ПРИМЕЧАНИЕ: Если вы даете другому человеку обратную связь, нужно соблюдать баланс (поддержка и критика). Всегда начинайте с позитивных моментов, обсуждения успехов. Далее поделитесь, что можно улучшить или есть предложения, как сделать по-другому. Завершите разговор на позитивной ноте.

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

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

Нажмите, чтобы увидеть ответ

Мы предлагаем такой вариант:

Обратная связь бывает позитивная, корректирующая и развивающая, когда руководитель задает вам вопросы. Если обратная связь вас расстроила или вызвала желание защищаться, то не торопитесь сразу оправдываться.

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

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

Специальные методики помогают сделать обратную связь полезной.

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

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