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

З мого досвіду безліч непорозумінь, затримок, а то й зривів дедлайнів, можна було уникнути, якби певні рішення були… записані. Так-так. Я думаю, і вам знайома ситуація, коли переважна частина вимог і технічних дискусій існують лише в памʼяті учасників та десь у нетрях вашого слаку.

Для цього не потрібно витрачати тижні на узгодження формулювань чи дотримання ритуалів. Обговорили — записали. Прийняли рішення — записали. І не на папірчику, а в доступному просторі.

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

Особливо це важливо для випадків, коли ви впроваджуєте не дуже очевидне чи нетипове рішення у вашому коді. І ні, я не говорю про коментарі, це окрема історія. Дуже часто іншому фахівцю важливо знати не що саме написано, а які рішення стоять за цим кодом. Бо він ні в кого не еталонний.

Я ж ставлю питання до причин та висновків, які призвели до появи цього коду. Це допоможе зрозуміти, а головне — прийняти, чого воно так написано.

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

Або починаєте роботу над задачею? Приділіть трохи часу, запишіть ваші роздуми. Знайшли якусь дич? Запишіть. Прийшла геніальна думка? Запишіть. І так далі. Як мінімум, коли ви за пів року подивитесь на свій код з доволі слушним запитанням "Якого хуя?!", відповідь на нього лежатиме просто перед вашими очима.

І так, користуватися LLM в цьому не лише можна, а й треба. Що він точно робить краще за мене, так це систематизує інформацію. Я можу накидати в нього все, що маю під рукою, а потім з цієї безформеної купи думок робити різноманітні документи на всякий смак. Очевидно, не варто кидати в модель чутливі чи корпоративні дані. Анонімізуйте хоча б, чи шо.

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

Якщо навчитися вирішувати це все ще на березі, то сама розробка буде відбуватися набагато плавніше і приємніше. Повірте старому морському вовку.

@babichdev

P.S. Ви ж не забули, що у нас досі триває збір для Житомирського військового інституту? Правда? ПРАВДА?
Тим паче, де ви ще зможете виграти артбук по STALKER 2 за 100 гривень донату? Отож.