Cómo funciona la explicación del código
El mapa de lo explicable, un tema una conversación y documentos que se quedan en el proyecto.
Explicar es la respuesta a una pregunta que nadie sabe formular bien: «¿qué proyecto es este y cómo funciona?». En lugar de ir preguntando en un chat y luego buscar la respuesta en una conversación de trescientas líneas, recibes un índice de temas y de cada uno un documento al que se puede volver.
El mapa de lo explicable
Lo primero que ves en la pestaña Proyecto → Explicaciones es la invitación a construir el mapa. El mapa es una lista de lo que en este proyecto merece una explicación: capas, módulos, el flujo de datos, archivos concretos. Lo construye el Agente, porque solo él sabe qué hay en el proyecto.
La construcción corre en segundo plano y el resultado no es un mensaje en una conversación, sino un archivo en el proyecto. No hace falta que estés delante: el mapa aparece en la aplicación por sí mismo en cuanto el Agente lo escribe.
En el mapa los temas están en grupos. El primer grupo es el general: la arquitectura, el diseño, el flujo de datos. Son preguntas que se pueden hacer sin conocer un solo archivo, por eso van primero. Las partes concretas están debajo.
El proyecto cambia, el mapa no. «Construir el mapa de nuevo» es por eso el botón que hay que usar cuando el proyecto ha avanzado: después de una refactorización grande, un mapa viejo confunde más de lo que ayuda.
Un tema, una conversación
Con un toque eliges un tema o varios y pulsas Explicar. La respuesta no va a la Conversación principal, sino a una propia, con el nombre del tema.
Eso es a propósito, no un detalle. Quien está haciendo trabajo no quiere el chat inundado con una exposición de la arquitectura; quien está aprendiendo el proyecto quiere volver al tema, no pescarlo en un chat. En esa conversación además se puede seguir preguntando, y las preguntas se quedan con el tema al que pertenecen.
En marcha y terminadas
Sobre el mapa hay dos secciones. Los temas en marcha son aquellos sobre los que ya corre una conversación. Las explicaciones terminadas son archivos del proyecto, en docs/explanations/: un tema, un archivo.
La diferencia está en qué sobrevive. Una conversación pertenece al Servidor y desaparece al cambiar de proyecto o con una limpieza. Un archivo del proyecto se queda, va a git y lo lee incluso un compañero que no tiene coden.
Lo que ya está explicado no se ofrece una segunda vez en el mapa. Si se ofreciera, no sabrías si continúas o empiezas de cero.
Para qué sirve
- Un proyecto nuevo. Construyes el mapa, te haces explicar el grupo general y en veinte minutos tienes una visión que de otro modo reunirías en dos días.
- Código ajeno. Justo el archivo que vas a tocar, explicado antes de que escribas en él.
- Documentación que surge como producto secundario. Los archivos de
docs/explanations/están escritos para leerse, no para un modelo, y se quedan en el proyecto. - Lectura sin conexión. Las explicaciones terminadas están en el espejo de Documentos, así que se abren también sin conexión.
Sin conexión
Encargar una explicación sin conexión con el Servidor no es posible: alguien tiene que trabajar al otro lado. Las ya guardadas se siguen leyendo, y la aplicación lo dice de entrada en lugar de dejar el botón sin reaccionar.
¿Se ha atascado en otro sitio distinto de lo que hay aquí? Escribe a support@coden-app.com.