| name | documentador |
| description | Genera documentacion de proyectos de codigo analizando el repositorio. Agnostico al lenguaje. Agrupa por modulo/concepto, no por archivo. NUNCA inventa descripciones.
|
| tools | ["Read","Glob","Grep","Bash","obsidian-mcp"] |
| updated | "2026-06-09T00:00:00.000Z" |
Documentador de Proyectos
Skill para generar documentacion de proyectos de codigo extrayendo informacion UNICAMENTE del codigo fuente. Agnostica al lenguaje.
Cuando usar esta skill
Cuando el usuario quiera documentar un proyecto de codigo en el vault: generar una wiki/base de conocimiento a partir del repositorio.
[!CAUTION]
Antes de crear o editar notas, lee las [[.agents/REGLAS_GLOBALES|Reglas Globales]].
Principios fundamentales
- DOCUMENTA SOLO LO QUE EXISTE: no inventes descripciones. Si no hay docstring, escribe
[Sin documentar].
- AGRUPA POR CONCEPTO, NO POR ARCHIVO: 6 archivos de agentes = 1 nota "Agentes", no 6 notas.
- DIAGRAMAS EN MERMAID: usa la skill
diagrama-arquitectura para cualquier diagrama. Nunca ASCII art.
Proceso
- Preguntar la ruta del repositorio
- Escanear estructura con
Glob y Grep
- Identificar componentes logicos (agrupar archivos relacionados)
- Mostrar plan al usuario y esperar confirmacion
- Crear UNA nota por componente en
02_Proyectos/<proyecto>/
Plan de documentacion
Objetivo: ~5-10 notas por proyecto, no 50+. Ejemplo:
55 archivos -> 6 notas:
- Indice (arquitectura general)
- Agente Principal (archivos de agente)
- API (endpoints y servidor)
- Core (logica de negocio)
- Utilidades (helpers, config)
- Pipeline (flujo de datos)
Estructura de nota de componente
---
title: "Componente - Nombre"
type: doc-proyecto
status: completo
tags: [nombre-proyecto]
source_files: [archivo1.py, archivo2.py]
created: 2026-06-09
updated: 2026-06-09
---
Secciones:
- Vision general del componente
- Clases/funciones principales (tabla con nombre, descripcion, parametros)
- Esquemas/modelos de datos
- Dependencias externas
Estructura del indice
---
title: "Proyecto - Nombre"
type: proyecto
status: completo
tags: [nombre-proyecto]
repo: "https://..."
stack: [lenguaje, frameworks]
created: 2026-06-09
updated: 2026-06-09
---
Secciones:
- Vision general de la arquitectura
- Tabla de componentes (nombre, descripcion, notas del vault)
- Dependencias externas
- Diagrama Mermaid de la arquitectura
Alcance de extraccion
Incluir: clases principales, metodos publicos, esquemas/modelos, funciones de entrada, docstrings literales, imports externos.
Excluir: funciones privadas (_), imports internos triviales, constantes obvias, __init__.py vacios, tests/, migrations/.
