Software Engineering
July 29, 2021

Записывай все, что знаешь

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

В комментариях в коде пиши, почему сейчас сделано именно так.

В коммит-месседжах пиши, почему что-то поменяли.

В тикетах пиши, как расследовали баг, как добавляли фичу.

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

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

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

Потом, когда буду искать концы, тебе скажут спасибо. Или ты сам себе скажешь.