Во время программирования - необходимо сообщать о прогрессе каждые несколько минут / часов с помощью:
- Описательные комментарии в системе отслеживания проблем
- Описательные сообщения фиксации
- Описательные теги (например, TODO) в исходном коде
Я написал «Описательный» жирным шрифтом и трижды в списке выше.
Почему так важно слово описательный? Потому что часто программисты ошибочно думают, что им платят за написание кода - это неправда! Код - это всего лишь один из инструментов, который вы используете для решения поставленных перед вами задач. Ваша настоящая работа - решать проблемы. Решаем инженерные задачи под рукой. Если код - это один из инструментов, то хорошая документация - это еще один инструмент, без которого ваши коллеги-инженеры окажутся в затруднительном положении. Они не могут перемещаться по вашему коду или улучшать его, развивая его до чего-то более красивого.
Итак, как вы можете быть более наглядным? Что ж, стань писателем лучше. Техническое письмо - это навык, который вам нужно отточить. А мы, программисты, можем позаимствовать советы у профессиональных писателей. Вспомните, как легендарный компьютерный ученый Дональд Кнут упомянул в своей работе« Грамотное программирование , что:
Программисты должны быть как эссеисты .. Всегда держать тезаурус в одной руке при написании кода ..
Одна из популярных ошибок, которые программисты часто совершают при написании технических комментариев к проблеме / коммит-сообщений / кодовых комментариев, заключается в том, что они часто добавляют в свой текст термины павлина или слова ласки. Читайте о них и избегайте их. Это класс 101, чтобы стать лучшим техническим писателем и приятным программистом для работы в команде.
Если вы это делаете - значит, вы втайне придерживаетесь принципов грамотного программирования. Вы превращаетесь в хорошего программиста, потому что ваш код теперь понятен не только компилятору, но и другим людям (вашим коллегам-инженерам или рецензентам кода), которые должны работать с вами и превращать ваш код во что-то более красивое, когда придет время. ..
В нашей команде мы стараемся применять вышеуказанные 3 практики и сообщать о прогрессе каждые несколько минут / часов. Также мы сообщаем о прогрессе:
я. Каждые несколько часов: установив соответствующий статус в системе отслеживания проблем
ii. Конец дня: записывая видео-журнал о том, какая работа была сделана, а что осталось на завтра
iii. Конец дня: путем размещения ссылок на комментарии к системе отслеживания проблем и видео-журналы в резервной комнате, предназначенной для проекта.
