Як записувати розвʼязки

• Перелічи кроки, які довелося зробити. Це можуть бути просто інструкції для людини. Може, консольні команди. Якщо йдеться про написання коду, може модулі, які створив чи редагував. Зазвичай перелік починається з мінімальних нотаток, а наскільки їх розкривати — залежить від аудиторії.

• Якщо знайшли крок у зовнішньому джерелі — статті, StackOverflow - не забуваємо посилання; коли наступного разу будуть питання, повернемось туди.

• Для кожного неочевидного кроку — пояснення: з якого розуміння вийшов саме такий крок. Потребу визначаємо самі, так би мовити, за “принципом сюрпризу”: якщо щось здивувало, потрібно записати.

• Також не забудь про неуспішні спроби та напрямки. Після того, як витратив багато часу, та все одно не вийшло — мусиш занотувати, щоб наступного разу не повторити.

• Особливо якщо є очевидний або “простий” шлях, який виявляється нежиттєздатним пізніше, обовʼязково потрібно про це записати. В мене зазвичай це виходить на другому підході — читаєш документацію — думаєш “навіщо воно так складно?” - через пару годин розумієш, чому. Потім пишу собі: “ні, так робити не треба, бо А, Б, В”

• Так, до речі, кожного разу як документ використовується, варто оновити його тими деталями, які раніше були невідомі, або просто додалися через зовнішні зміни.

Найбільш обкатаний з відомих мені процесів — це налаштування нашої екосистеми для нового інженера. Так склалося через те, що щоразу ми адаптуємо ті частини, що не спрацювали — традиція така є. А з іншого боку, процес досить складний, тож нові та нові нюанси не припиняють зʼявлятися.