14. Программист и тексты

Программист должен уметь писать не только код, но и любые другие тексты.

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

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

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

Есть три обязательных компонента развития навыка письма:

  • Изучение литературы о том, как нужно писать тексты. Обязательна к прочтению книжка «On Writing Well»;
  • Внимательное чтение чужих текстов;
  • Постоянно написание и переписывание своих текстов.
Мнения менторов

Хочешь узнать, как программист пишет код? Просто посмотри, как он пишет текст.

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

Почему так? Когда мы пишем код, мы ограничены кодстайлом и рекомендациями комьюнити. Однако когда мы пишем произвольный текст, может показаться, что у нас есть полная свобода. На мой взгляд, здесь и проявляется наше отношение к порядку — хотим ли мы добровольно писать по "кодстайлу" нашего языка (правила орфографии и пунктуации, форматирование текста) или мы идём по пути наименьшего сопротивления?

Ещё почитать на эту тему