agentleFS
Sign inStart free
MazalucasMazalucas/El-DT-Lightweight-Army/.cursor/rules/02-documentacion.mdc

El-DT-Lightweight-Army / rules

Cursor rule4 starsChanged 19 days agoMITView on GitHub

OBLIGATORIO al crear o editar docs/ — protocolo DOC-META-001, capas, IDs, catálogo sync-catalog

The file

Create a free account to mount
Files
02-documentacion.mdc
---
description: OBLIGATORIO al crear o editar docs/ — protocolo DOC-META-001, capas, IDs, catálogo sync-catalog
globs: "docs/**"
alwaysApply: false
---

# Documentación (DT)

Carga automática con glob `docs/**`. Si vas a crear docs **sin** archivos abiertos aún, el DT debe leer esta regla igual (mandato en `00-orquestador-core`).

**Canónico completo:** abrir **`docs/99_meta/protocolo-documentacion-ia.md`** (`DOC-META-001`) antes de crear o refactorizar bajo `docs/`.

## Capas bajo `docs/`

```text
00_overview/  01_concepts/  02_guides/  03_reference/
04_architecture/  05_decisions/  06_operations/  07_glossary/  99_meta/
```

Portal: `docs/README.md` (`DOC-OV-001`). Telemetría DT: `vitals/INDEX.md` (complemento, no reemplazo de docs).

## Qué cambió → dónde

| Cambio | Capa | ID |
|--------|------|-----|
| DT / reglas / pipeline | `00_overview/` o rule-bodies | `DOC-OV-*` |
| Concepto / por qué | `01_concepts/` | `DOC-CONCEPT-*` |
| How-to | `02_guides/` | `DOC-GUIDE-*` |
| Contrato estable | `03_reference/` + CHANGELOG | `DOC-REF-*` |
| Arquitectura | `04_architecture/` | `DOC-ARCH-*` |
| Decisión (ADR) | `05_decisions/` | `DOC-DEC-*` |
| Runbook / ops | `06_operations/` | `DOC-OPS-*` |
| Glosario | `07_glossary/` | `DOC-GLOSS-*` |
| Evento orquestación | `vitals/pulse/entries/` | `pulse_id` |

Si dudás: capa de **mayor autoridad** (decision > architecture > reference > guide) y enlazá desde la otra.

## Obligaciones mínimas

1. **Fuente única** — un concepto, un doc canónico (`source_of_truth: true` donde aplique).
2. **Frontmatter YAML** en todo `.md` nuevo bajo `docs/`: `id`, `title`, `type`, `status`, `owner`, `updated`, `tags`, `summary`, `related`, `priority`, `source_of_truth`.
3. **IDs** `DOC-<DOMINIO>-<NNN>` — registrar dominios nuevos en `docs/99_meta/id-registry.md`. Próximo libre: `ruby scripts/sync-catalog.rb --next <DOMINIO>`.
4. **Plantillas** en `docs/99_meta/templates/` según `type`.
5. **Catálogo** — `ruby scripts/sync-catalog.rb` tras agregar/mover docs (no editar `catalog.yaml` a mano).
6. **Nombres** semánticos estables; evitar `final-v2`, `misc`.

## ADR (mínimo)

Contexto · Decisión · Consecuencias. Tipos: `overview`, `concept`, `guide`, `reference`, `architecture`, `decision`, `runbook`, `glossary`, `policy`, `faq`.

## Checklist antes de cerrar doc nuevo

- [ ] Capa correcta y ID registrado
- [ ] Frontmatter completo
- [ ] `sync-catalog.rb` ejecutado si aplica
- [ ] Enlaces internos válidos
- [ ] Detalle profundo en DOC-META-001 consultado si el doc es no trivial

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free