Легко найти программистов с крайне плохими (я не имею в виду плохие, которые на самом деле означают хорошие, я имею в виду плохие плохие) навыки письма. Думаю, это хороший способ начать. Ну, я по одной причине был очень плохим писателем (прочитав это, пожалуйста, скажите мне, если я все еще такой). Но в стремлении писать для машин, станем ли мы лучше писать для людей?

По словам Джеффа Этвуда (Кодинг ужасов)

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

Сложности

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

1. Грамматика.
2. Лексическая структура.
3. Прилагательные (блин!, прилагательные)

и многое другое, еще раз внимательно посмотрите, что это такое.

Грамматист: Я не совсем уверен, что точно помню, что это такое. Думайте об этом как о семантическом анализаторе компилятора, проверяющем, построено ли дерево синтаксического анализа в соответствии с правилами языка.

Лексическая структура: убедитесь, что отдельные слова передают определенное значение.

Прилагательные. Те слова, которые помогают вам описать что-то и лучше изобразить, думайте о них как о фасадах laravel (довольно приятная особенность).

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

Но еще не поздно (думаю?), желание любого разработчика — стать маяком для сообщества (ну, по крайней мере, это мое).

Разрушая это

где пишут программисты и почему они пишут.

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

Программисты (документация)
Непрограммисты (блоги и технические разговоры)

Программистам, по моему мнению, писать проще, но легко не обязательно означает легко (видите, что я там сделал?).

Написание для других разработчиков требует, по сути, очень внимательного изучения программного обеспечения, модуля, API (или просто кода) и тщательного описания их работы, чтобы помочь следующему парню, который захочет попытаться превратить его в бомбу. Эта форма письма распространена в документации, readme и многих других бумажных работах.

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

Настоящая задача с этими парнями — настроиться на кодовый босс-человек-корабль (трепет перед крутизной, который испытывают разработчики, когда они пишут о OAuth Stateless Authentication, бла-бла-бла, методах, функциях и многом другом).

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

Итак, как все это дерьмо касается вас, кодера, который хочет писать.

В основном это говорит следующее в определенном порядке

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

Документация: здесь вы пишете, чтобы полностью объяснить свое творение, чтобы другие программисты могли извлечь из него достаточно понимания, чтобы они могли использовать его для создания лучших вещей (например, Аполлон-11).

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

Вывод

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

Писать легко, все, что вам нужно сделать, это зачеркнуть неправильные слова

-Марк Твен