Вітаю українських націоналістів (космополітів для втікачів не вітаю).

Нещодавно я наштовхнувся на складну проблєму - треба було роздуплитись, як працює велика купа недокументованого коду.

Спершу я спробував як завше - дивитись на той код очима, доки воно саме по собі не складеться в моїй голові до купи. Але той код був настільки заплутаним, що в мене нічого не вийшло.

Я почав думати - а шо робить в таких ситуаціях? І придумав, шо треба таки уважно дивитись на той код, аби краще розуміти, шо там робиться. І потім я згадав про застосунок Obsidian.

Ідея Obsidian в тому, шо за допомогою простого markdown мона робити нотатки, які пов'язані між собою, як от сторінки в вікіпедії. А потім можна дивитись на граф цих зв'язків, і бачити, які нотатки посилаються на які.
При цьому не обов'язково безпосередньо створювати сторінку для якоїсь штуки, можна просто написати якесь слово в подвійних квадратних дужках, і слово в цих дужках буде показуватись на графі, навіть якшо воно не асоційоване з якоюсь сторінкою.

Поки шо мені це подобається, і ніби допомагає краще розуміти взаємозв'язки між файлами, але я думаю про те, як краще описувати складні файли.
Зараз я роблю так:
Створив нотатку з файлом. В ньому список функцій в файлах. Кожна функція - це нотатка з описом, шо робе ця функція, та посиланнями на інші функції, якшо вони використовуються.
Я також робив ледь не порядковий опис функцій (з описом розгалужень if), але це по суті той самий код функції, але іншими словами, тому я думаю, шо краше описувати той результат, який ми хочемо отримати в результаті роботи функції.

Шо думаєте?