Як працює пояснення коду
Карта того, що можна пояснити, одна тема — одна розмова, і документи, що залишаються в проєкті.
Пояснення — це відповідь на питання, яке ніхто не вміє добре поставити: «що це за проєкт і як воно працює?» Замість того, щоб допитуватися в чаті, а потім шукати відповідь у розмові на триста рядків, ви отримаєте перелік тем і з кожної один документ, до якого можна повернутись.
Карта того, що можна пояснити
Перше, що ви побачите у вкладці Проєкт → Пояснення, — це запрошення скласти карту. Карта — це список того, що в цьому проєкті варте пояснення: шари, модулі, потік даних, конкретні файли. Складає її Агент, бо лише він знає, що в проєкті є.
Складання йде у фоні, і результат — не повідомлення в розмові, а файл у проєкті. Бути при цьому не треба — карта з'явиться в застосунку сама, щойно Агент її запише.
У карті теми зібрані в групи. Перша група загальна: архітектура, задум, потік даних. Це питання, які можна поставити, не знаючи жодного файлу — тому вони перші. Конкретні частини — під ними.
Проєкт змінюється, карта ні. «Скласти карту знову» — тому та кнопка, якою варто скористатися, коли проєкт зрушив: після більшого рефакторингу стара карта скоріше збиває з пантелику, ніж допомагає.
Одна тема, одна розмова
Дотиком ви обираєте одну тему або кілька і натискаєте Пояснити. Відповідь не йде в головну Розмову, а у власну, названу за темою.
Це задум, а не дрібниця. Хто робить роботу, не хоче мати чат, залитий викладом архітектури; хто вчить проєкт, хоче повертатися до теми, а не виловлювати її в чаті. У тій розмові до того ж можна допитуватись далі — і питання залишаються при темі, до якої належать.
У роботі та готові
Над картою є два розділи. Теми в роботі — це ті, про які розмова вже йде. Готові пояснення — це файли в проєкті, в docs/explanations/ — одна тема, один файл.
Різниця між ними в тому, що виживає. Розмова належить Серверові і після перемикання проєкту або прибирання зникає. Файл у проєкті залишається, іде в git, і його прочитає навіть колега, у якого coden немає.
Те, що вже пояснено, у карті вдруге не пропонується. Якби пропонувалося, ви не знали б, чи продовжуєте, чи починаєте з нуля.
Для чого це добре
- Новий проєкт. Складете карту, пояснюєте собі загальну групу — і за двадцять хвилин маєте огляд, який інакше складали б два дні.
- Чужий код. Саме той файл, до якого збираєтесь торкнутися, пояснений вам раніше, ніж ви в нього запишете.
- Документація, що виникає як побічний продукт. Файли в
docs/explanations/написані для читання, а не для моделі — і залишаються в проєкті. - Читання без з'єднання. Готові пояснення лежать у дзеркалі Документів, тож відкриються і офлайн.
Без з'єднання
Замовити пояснення без з'єднання із Сервером не вдасться — на тому боці хтось має працювати. Уже збережені читаються далі, і застосунок каже це прямо, а не залишає кнопку без реакції.
Застрягло десь інде, ніж тут написано? Напишіть на support@coden-app.com.