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