Documentación

Contexto del proyecto

Adjunte los documentos, políticas y referencias que el repositorio por sí solo no puede transmitir a los agentes.

Los agentes leen su código. Contexto Es donde se incluye lo que el código no puede expresar: las decisiones, restricciones y convenciones que existen fuera de él.

Para conocer la razón detrás de lo que corresponde aquí, lea Contexto del proyecto en la sección de Conceptos. Esta página explica cómo gestionarlo.

Añadir contexto

Abra la sección de Contexto del proyecto y agregue una entrada. Cada una cuenta con un título y cuerpo, y puede editarse o eliminarse posteriormente.

Las buenas entradas son breves, específicas y duraderas. Las decisiones de arquitectura, convenciones de estilo, contratos API, límites de propiedad y prohibiciones explícitas pertenecen aquí. La narrativa de incorporación y todo lo que ya sea evidente en el repositorio no deben incluirse.

Mantenga las entradas separadas y bien nombradas

Una entrada por tema, titulada según lo que abarque. "Convenciones de manejo de errores" y "Módulos congelados" son fáciles de localizar; una única entrada llamada "Notas" que contenga ambos no lo es.

Esto es importante porque el contexto se carga selectivamente según el trabajo en curso; consulte Habilidades progresivas. Las entradas bien separadas permiten que se cargue la adecuada para cada tarea.

Referencias

Además de las entradas escritas, puede adjuntar referencias: enlaces y documentos que apuntan a material almacenado en otro lugar. Úselas cuando la copia autorizada se encuentre en una wiki o herramienta de diseño y no desee tener una segunda copia que quede desactualizada.

Contexto por tarea

El contexto del proyecto se aplica a todo lo contenido en él. Para material relevante para una tarea específica —un ticket, un informe de cliente, un documento de diseño—, adjúntelo a esa tarea. Una nota específica de una tarea incluida en el contexto del proyecto generará ruido en todas las tareas futuras.

Mantenerlo actualizado

Un contexto obsoleto es peor que un contexto ausente, ya que los agentes lo consideran autoritativo. Cuando una convención cambie, actualice la entrada en la misma modificación que altera el código.

Revisar lo que existe

Lea su contexto ocasionalmente como si fuera nuevo. Las entradas se acumulan, y las redactadas durante una migración finalizada hace un año ahora pueden ser engañosas.