Comment fonctionne l'explication du code
La carte de ce qui peut être expliqué, un sujet une conversation, et des documents qui restent dans le projet.
Expliquer est la réponse à une question que personne ne sait bien poser : « c'est quoi ce projet et comment ça marche ? » Au lieu d'aller demander dans un chat et de chercher ensuite la réponse dans une conversation de trois cents lignes, vous obtenez un sommaire de sujets et, de chacun, un document auquel on peut revenir.
La carte de ce qui peut être expliqué
La première chose que vous voyez dans l'onglet Projet → Explications est l'invitation à établir la carte. La carte est la liste de ce qui, dans ce projet, mérite une explication — les couches, les modules, le flux de données, des fichiers précis. C'est l'Agent qui l'établit, car lui seul sait ce qu'il y a dans le projet.
L'établissement tourne en arrière-plan et le résultat n'est pas un message dans une conversation, mais un fichier dans le projet. Vous n'avez pas besoin d'être là — la carte apparaît d'elle-même dans l'application dès que l'Agent l'a écrite.
Dans la carte, les sujets sont en groupes. Le premier groupe est le général : l'architecture, la conception, le flux de données. Ce sont des questions qu'on peut poser sans connaître un seul fichier — c'est pour ça qu'elles sont en premier. Les parties précises sont en dessous.
Le projet change, la carte non. « Établir la carte à nouveau » est donc le bouton à utiliser quand le projet a avancé — après une grosse refactorisation, une vieille carte embrouille plus qu'elle n'aide.
Un sujet, une conversation
D'un appui vous choisissez un sujet ou plusieurs, puis vous faites Expliquer. La réponse ne va pas dans la Conversation principale, mais dans une conversation propre, nommée d'après le sujet.
C'est voulu, pas un détail. Celui qui fait du travail ne veut pas voir son chat noyé sous un exposé de l'architecture ; celui qui apprend le projet veut revenir au sujet, pas le pêcher dans un chat. Dans cette conversation on peut d'ailleurs continuer à demander — et les questions restent avec le sujet auquel elles appartiennent.
En cours et terminées
Au-dessus de la carte il y a deux sections. Les sujets en cours sont ceux dont une conversation parle déjà. Les explications terminées sont des fichiers du projet, dans docs/explanations/ — un sujet, un fichier.
La différence entre eux est ce qui survit. Une conversation appartient au Serveur et disparaît après un changement de projet ou un nettoyage. Un fichier du projet reste, va dans git, et même un collègue qui n'a pas coden le lit.
Ce qui est déjà expliqué n'est pas proposé une seconde fois dans la carte. Si ça l'était, vous ne sauriez pas si vous continuez ou si vous repartez de zéro.
À quoi ça sert
- Un nouveau projet. Vous établissez la carte, vous vous faites expliquer le groupe général et en vingt minutes vous avez une vue d'ensemble que vous auriez sinon assemblée en deux jours.
- Du code étranger. Précisément le fichier auquel vous allez toucher, expliqué avant que vous écriviez dedans.
- De la documentation qui naît comme produit secondaire. Les fichiers dans
docs/explanations/sont écrits pour être lus, pas pour un modèle — et ils restent dans le projet. - La lecture sans connexion. Les explications terminées sont dans le miroir des Documents, elles s'ouvrent donc aussi hors ligne.
Sans connexion
Commander une explication sans connexion au Serveur n'est pas possible — de l'autre côté, quelqu'un doit travailler. Celles déjà enregistrées se lisent toujours, et l'application le dit d'emblée au lieu de laisser le bouton ne pas réagir.
Ça a coincé ailleurs que ce qui est ici ? Écrivez à support@coden-app.com.