msaldain
47fc69508d
- Agrega CLAUDE.md como documento orquestador - Estructura .claude/ en codigo/, decisiones/ y referencias/ - Documenta decisiones de codigo, commits, documentacion, notas y minutas - Incorpora las skills recontextualizar e inicializarProyecto - Corrige rutas rotas y agrega designPatterns, sobreCLAUDE y sobreREADME al orquestador
1.6 KiB
1.6 KiB
Decisiones en cuanto a la documentación creada por Claude Code
README.md
- El archivo README.md no se utilizará como archivo que incorpore un índice sobre la documentación del proyecto.
- Este archivo README.md contendrá un resumen de la organización de las etapas del proyecto, plazos por etapa, planes de acción por etapa, requisitos indispensables establecidos por los docentes.
- Más información sobre como construir el archivo README.md en .claude/decisiones/sobreREADME.md
Estilos
- Si el usuario no indica lo contrario usar Markdown como tipo de documento predeterminado para crear documentación.
- No se usarán emojis en la documentación
- No se firmará como en colaboración con IA
Índices
- Todos los grandes directorios de documentación deberán contar con un índice.
- En Indice.md se encontrará el índice que mantiene actualizada la documentación de cada etapa.
Estructura
- Es posible que a medida que se avance con las etapas la documentación crezca y se haga insostenible tener todo dentro de un único archivo con la documentación.
- Dentro de la carpeta docs/ va a alojarse la documentación.
- Dentro de docs/ encontraremos sub-carpetas correspondientes a cada hito, Hito 1 es una de ella.
- Dentro de cada sub-carpeta de etapa habrán archivos que corresponderán a secciones, estas secciones pueden definirse anteriormente al iniciar una nueva etapa dentro de secciones.md o puede actualizarse a medida que se vayan creando las secciones si no se precargó.