Умение понятно писать – один из самых недооцененных инженерных навыков

Мне кажется, что умение понятно писать – ясно излагать мысли, создавать понятные описания и ясные инструкции, формулировать четкие вопросы и давать полезные ответы – один из самых недоразвитых сейчас навыков среди инженеров. Недоразвитых, и недооцененных.

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

Конечно, есть миллион других навыков, которые не помешали бы инженеру, но я выделяю этот, потому что это low hanging fruit: большинство инженеров уже умеют думать, и уже хорошо разбираются в предмете. Не хватает, по-моему, малого – немного научиться думать о читателе.

Я говорю о совсем простых вещах, вроде

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

Это удивительно универсальные простые вещи: они подсказывают, как писать понятные людям email-ы и сообщения в мессенджерах, как писать полезные комментарии в коде, как составлять читабельные инструкции и отчеты, и даже как строить презентации. Может, и в других случаях тоже помогают, но я пока не пробовал.

И чтобы их освоить на базовом уровне – достаточно прочитать 3-4 главы "Пирамиды Минто"¹. Это пара вечеров на прочтение, и пара недель на попрактиковаться без отрыва от производства – но почему-то даже такой базовый уровень встречается у одного из 4-5 инженеров.

И это очень обидно, ведь неумение понятно писать часто обесценивает хорошую техническую, инженерную работу!

В последние полтора года недостаток этого умения писать думая о читателе очень бросается в глаза: объем переписки сильно возрос, большое количество усного общения перешло в письменную форму, и это адищще – переписка и так гораздо медленнее усного общения, но она затягивается еще в полтора-два раза, так как участники не могут сразу ясно сформулировать свою мысль.

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

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

В обоих этих – и многих других, похожих – случаях встает вопрос: что мешало автору описать свою систему – из каких идей и ограничений сложился дизайн, и как этим всем пользоваться?

Когда я задаю этот вопрос, обычно слышу в ответ что-то про недостаток времени. Но я думаю, что это миф: настоящая причина в недостатке навыка, а не времени.

Потому что для проекта в сотни тысяч строк кода – достаточно всего пары десятков страниц, чтобы описать ключевые идеи и концепции, и проинструктировать по основным приемам использования. То есть объем минимально-полезной документации (minimal valuable documentation, MVD) – единицы процентов от объема кода, а польза от нее огромна – несоизмерима с процентами дополнительных затрат.

Если задуматься, то это удивительно: человек тратит месяцы на написание сотен тысяч строк кода. Хорошего кода – продуманного, выстроенного, вылизанного, оптимизированного. Но тот же самый человек почему-то оказывается не способен написать несколько десятков страниц на человеческом языке, хотя бы вполовину так же продуманно и тщательно!

Примечания

1. Barbara Minto "The Pyramid Principle: Logic in Writing and Thinking"/"Принцип пирамиды Минто®. Золотые правила мышления, делового письма и устных выступлений"

   Книга Барбары Минто – классика организации деловой переписки, и вообще аргументированного письма. По мне, так это полноценный учебник письменной риторики. Издается, кажется, еще с 1970-х, и совершенно не устарела. Книга довольно большая, очень детальная, и немного занудная, но самые важные принципы изложены уже в первых 3-4 главах – для первого знакомства нет необходимости читать все.↩︎