Лучшие люди учат

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

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

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

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

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

Запиши это

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

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

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

Экономит время

Одно из основных преимуществ написания руководств и статей - это экономия времени.

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

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

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

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

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

Документация

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

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

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

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

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

Парное программирование

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

Это полезно, даже если это не проблема (например, концепция или некоторые базовые этапы установки).

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

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

Вы можете зарабатывать деньги

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

Разве это не здорово?

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

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

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

Заключение

Если вы еще не пишете, начните сегодня же! Начните с простых инструкций по установке или фрагмента кода. Неважно.

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

Я уверен, что это принесет вам большую пользу в будущем.