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

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

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

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

Доступна ли часть работы пользователю? Им обязательно понадобятся инструкции. Эти инструкции должны быть четкими, как будто твой папа работал на стекольном заводе. Лаконично, типа «Ты — самое слабое звено!» Просто, как будто мы на Улице Сезам. Синему не нужна подсказка, чтобы ориентироваться в использовании вашей программы.

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

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