Я качаюсь в кодировании! Но как мне лучше говорить?

Недавно два моих друга-программиста указали мне на важность навыков письма.

Имеет смысл обратить внимание на то, что они говорят, потому что:

• Один управляет онлайн-продуктовой компанией.

• Другой прошел путь от выпускника буткемпа до ведущего разработчика всего за несколько лет.

Давайте посмотрим на краткое руководство по улучшению вашего письма в повседневной работе.

Разбейте текст на абзацы

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

Разбивка на абзацы сделает ваш текст более экономичным, менее громоздким и более легким для чтения. Меньшие куски сохраняют умственную энергию вашего читателя.

Используйте некоторые из доступных стилей

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

• Смелый.

• Курсив.

• Заголовки.

• Подчеркивание или

• Зачеркнутый

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

Облегчить читателю

Есть две вещи, которые вы можете сделать, чтобы облегчить жизнь своим читателям:

• Используйте HTML-ссылки и

• включать изображения в текст, чтобы передать ваше сообщение или объяснить проблему

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

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

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

![В Интернете есть ссылки с 1991 года и изображения с 1992 года. Давайте их использовать!]

Прочитайте и отредактируйте написанное

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

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

Редактирование является ключом к хорошему опыту чтения. Делать это самостоятельно должно быть достаточно для большинства вещей, которые вы пишете, и это элементарная вежливость по отношению к вашим читателям.

Используйте автоматизированные инструменты для улучшения письма

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

• ловить правильно написанные слова, используемые в неправильных местах (как я все время делаю с «тогда» и «чем»).

• Маркировка пассивного залога — использование активных залогов делает ваше письмо более ярким.

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

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

Грамматически

Если вы получаете подобную рекламу на YouTube, вы наверняка слышали о ней. Пользуюсь с июля 2021, доволен. Это было первое серьезное улучшение качества, которое я реализовал в своем блоге.

Плюсы:

• Он понимает контекст слов и предлагает соответствующие изменения: он скажет вам, имеете ли вы в виду «это» или «это».

• Он указывает на чрезмерно используемые слова и предлагает другие варианты.

• В платной версии может предлагать перестройку предложения.

Минусы

• Отсутствие поддержки других языков, кроме английского.

• Плагин Firefox на Mac не работает с Google Docs.

• Платная версия стоит 144$/год, что больше, чем у конкурентов.

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

Языковые инструменты

Плюсы:

• он поддерживает больше языков (грамматическая коррекция на 5 европейских языках), более базовая поддержка 20 языков и многое другое

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

Минусы:

• меньше маркетинга — я нашел их, только когда начал расспрашивать

Станьте лучшим другом своих читателей

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

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

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

Ранее опубликовано [здесь] (https://how-to.dev/how-to-write-better-as-a-developer)