Engineering docs

22 habilidades componibles y de activación automática que convierten tu agente de codificación en un ingeniero principal, desde la idea inicial hasta documentación lista para producción.

Documentación

Documentación de Ingeniería

22 habilidades componibles y de activación automática que convierten a tu agente de codificación en un ingeniero principal, desde la idea inicial hasta la documentación lista para producción.

License: MIT npm version GitHub stars Listed on ClaudePluginHub


¿Por qué Documentación de Ingeniería?

Tu agente de codificación es poderoso, pero no conoce la arquitectura de tu proyecto, tus usuarios ni tus restricciones. Documentación de Ingeniería le otorga habilidades de documentación a nivel de ingeniero principal, para que pueda:

  • Convertir ideas en bruto en planos completos — concepto de negocio → especificación técnica → arquitectura → plan de implementación
  • Hacer las preguntas correctas — entrevistas mediante llamadas a herramientas con 2-3 preguntas específicas por habilidad (sin preguntas repetidas)
  • Generar documentos listos para producción — ISO/IEC/IEEE 29148, Modelo C4, STRIDE, estándares de Google SRE
  • Funcionar con más de 14 agentes — Claude Code, Copilot, Cursor, Gemini CLI, Goose, Pi y más

Cómo Funciona

Engineering Docs Plugin Workflow

El plugin funciona mediante un flujo de trabajo estructurado:

  1. El usuario da una idea → La habilidad de orquestación se activa automáticamente
  2. Detección de modo → Greenfield (nuevo) vs Brownfield (existente)
  3. Fase de entrevista → Preguntas mediante llamadas a herramientas con carga de contexto
  4. Generación de documentos → Generación secuencial con 22 habilidades especializadas
  5. Verificaciones de consistencia → Validación cruzada entre documentos
  6. Índice maestro → Plano completo listo para implementación

Inicio Rápido

npx engineering-docs

O instala para tu agente específico:

AgenteComando de Instalación
Claude Code/plugin install engineering-docs@claude-plugins-official
Gemini CLIgemini extensions install https://github.com/fattain-naime/engineering-docs
Cursor/add-plugin engineering-docs
Goosegoose configure → añadir extensión
Pipi install git:github.com/fattain-naime/engineering-docs
OpenCodenpx engineering-docs --opencode
Kilo CodeInstalar desde el marketplace de plugins de Kilo Code
Roo CodeInstalar desde el marketplace de plugins de Roo Code
Clinenpx engineering-docs --cline
Kimi Code/plugins install https://github.com/fattain-naime/engineering-docs
CodexInstalar desde el marketplace de plugins de Codex
Copilot CLInpx engineering-docs --copilot
Factory Droidnpx engineering-docs --factory

Consulta Instalación para instrucciones detalladas.


Cómo Funciona

graph LR
    A[Your Idea] --> B[Orchestrator]
    B --> C{Interview}
    C --> D[Business Concept]
    D --> E[Project Plan]
    E --> F[Technical Spec]
    F --> G[System Architecture]
    G --> H[API Design]
    H --> I[Implementation Plan]
    I --> J[Test Strategy]
    J --> K[Deployment Plan]
    K --> L[Master Index]
  1. Dale tu idea — "Quiero construir X"
  2. Responde 2-3 preguntas por habilidad — mediante llamadas a herramientas, no en el chat en línea
  3. Revisa cada documento — aprueba o solicita cambios
  4. Obtén tu plano — conjunto de documentación completo y consistente

Características inteligentes:

  • Carga de contexto — lee documentos previos antes de hacer preguntas (nunca se repite)
  • Entrevistas mediante llamadas a herramientas — captura de entrada limpia, sin contaminar la conversación
  • Dimensionamiento correcto — omite documentos que no aplican a tu proyecto
  • Consistencia entre documentos — verifica que nombres de entidades, roles y decisiones coincidan

Qué Incluye

Biblioteca de Habilidades (22 Habilidades)

Descubrimiento y Planificación

HabilidadQué Produce
using-engineering-docsOrquestador — enruta automáticamente a todas las demás habilidades
business-conceptProblema, usuarios, propuesta de valor, monetización, restricciones
project-planAlcance, hitos, RACI, cronograma, desglose de trabajo
user-personas-behaviorPersonas de usuario, JTBD, métricas de éxito, plan de analítica

Especificación y Viabilidad

HabilidadQué Produce
technical-specificationSRS/TSD con sintaxis EARS, matriz de trazabilidad
technical-feasibility-studyRecomendación de continuar/no continuar con evidencia

Arquitectura y Diseño

HabilidadQué Produce
system-architecture-documentDiagramas C4, vistas 4+1, stack tecnológico, NFRs
architecture-decision-recordRegistro inmutable de ADR (formato MADR)
database-design-documentERD, esquema, indexación, plan de migración
api-design-documentContrato REST/OpenAPI 3.1, errores RFC 7807
admin-access-control-specificationMatriz RBAC, registro de auditoría, break-glass
technical-blueprintTDD de calidad Google/Stripe por funcionalidad
ux-flow-specificationRecorridos de usuario, flujos de pantalla, estados de UI
design-system-specificationTokens de diseño, componentes, accesibilidad

Calidad y Riesgo

HabilidadQué Produce
security-threat-modelAnálisis STRIDE, superficie de ataque, mitigaciones
test-strategy-documentPirámide de pruebas, puertas de CI, objetivos de cobertura
implementation-planSecuencia de compilación ordenada por dependencias, puertas de fase

Entrega y Operaciones

HabilidadQué Produce
deployment-planEstrategia de lanzamiento, puerta de continuar/no continuar, reversión
slo-error-budget-documentObjetivos SLI/SLO, alertas de tasa de consumo
technical-runbookManual de operaciones de guardia (Google SRE)
disaster-recovery-planRTO/RPO, estrategia de respaldo, conmutación por error
incident-postmortemRCA sin culpas con los Cinco Porqués

Agentes Personalizados (4 Agentes)

AgentePropósito
documentation-generatorGenerar documentación integral para proyectos de software
architecture-reviewerRevisar la arquitectura del sistema en cuanto a escalabilidad, seguridad y mantenibilidad
api-designerDiseñar APIs RESTful siguiendo las mejores prácticas
test-strategistCrear estrategias de prueba integrales para proyectos de software

Scripts de Utilidad

ScriptPropósito
generate-dependency-graph.jsVisualización de dependencias con Mermaid
validate-documents.jsValidación de documentos
calculate-error-budget.jsCalculadora de presupuesto de errores SLO
generate-test-cases.jsGenerador de casos de prueba a partir de especificaciones
generate-ddl.jsGenerador de DDL SQL a partir del esquema
check-consistency.jsVerificador de consistencia entre documentos

Integración MCP

.mcp.json          # MCP server configuration
scripts/validate.js    # Validation server (validate_document_set, check_consistency, generate_index)

Hooks

hooks/hooks.json          # SessionStart hook configuration
hooks/check-progress.js   # Check for in-progress documentation
hooks/run-hook.cmd        # Windows compatibility

Marco de Evaluación

evals/evals.json           # Test cases for orchestrator and key skills
evals/README.md            # How to run evals
evals/test-prompts/        # Sample test prompts

Estructura del Plugin (Compatible con Claude)

engineering-docs/
├── .claude-plugin/
│   ├── plugin.json        # Plugin manifest
│   └── marketplace.json   # Marketplace manifest
├── skills/                # 22 skills (SKILL.md files)
├── agents/                # 4 custom agents
├── hooks/                 # Event handlers
├── .mcp.json              # MCP server configuration
├── scripts/               # All scripts (install, validate, test, utilities) (install.js, validate.js, test-skills.js)
├── scripts/               # Utility scripts + setup scripts
├── evals/                 # Test framework
└── integrations/          # Other agent platform configs
    ├── agents/            # Agent configs (AGENTS.md, CLAUDE.md, GEMINI.md)
    └── plugins/           # Plugin configs for 13+ platforms

Cumplimiento de las Directrices de Claude:

  • ✅ Componentes en la raíz del plugin (no dentro de .claude-plugin/)
  • ✅ Habilidades en el directorio skills/ con SKILL.md
  • ✅ Agentes en el directorio agents/ con frontmatter
  • ✅ Hooks en hooks/hooks.json
  • ✅ MCP en .mcp.json
  • ✅ Nomenclatura kebab-case
  • ✅ Validaciones aprobadas: claude plugin validate .

Instalación

Instalador CLI (Recomendado)

npx engineering-docs

Detecta automáticamente y copia el plugin al directorio de tu agente.

Instalación por Agente

Claude Code

# Official marketplace
/plugin install engineering-docs@claude-plugins-official

# Or register marketplace first
/plugin marketplace add fattain-naime/engineering-docs
/plugin install engineering-docs@engineering-docs

Gemini CLI

gemini extensions install https://github.com/fattain-naime/engineering-docs

O clona manualmente:

git clone https://github.com/fattain-naime/engineering-docs.git ~/.gemini/config/plugins/engineering-docs

Cursor / Windsurf

npx engineering-docs --cursor

Extrae cada habilidad a .cursor/rules/engineering-docs-*.mdc.

Goose

npx engineering-docs --goose

O configura manualmente en ~/.config/goose/config.yaml.

Pi

npx engineering-docs --pi

O instala desde git:

pi install git:github.com/fattain-naime/engineering-docs

OpenCode

npx engineering-docs --opencode

Kilo Code

npx engineering-docs --kilo

O instala desde el marketplace de plugins de Kilo Code.

Codex / GitHub Copilot

npx engineering-docs --codex

Copilot CLI

npx engineering-docs --copilot

Cline

npx engineering-docs --cline

Copia .clinerules a la raíz de tu proyecto.

Factory Droid

npx engineering-docs --factory

Roo Code

npx engineering-docs --roo

Kimi Code

npx engineering-docs --kimi

O instala dentro de Kimi Code:

/plugins install https://github.com/fattain-naime/engineering-docs

Scripts Multiplataforma

# Windows (PowerShell)
pwsh scripts\setup.ps1
pwsh scripts\setup.ps1 -Target gemini
pwsh scripts\setup.ps1 -Target claude

# Linux / macOS (Bash)
chmod +x scripts/setup.sh
./scripts/setup.sh
./scripts/setup.sh --gemini
./scripts/setup.sh --claude

Objetivos compatibles: gemini, claude, local, cursor, kimi, codex, goose, pi, opencode, kilo, roo, cline, factory, copilot

Comportamiento de Escritura Segura

Todos los métodos de instalación utilizan escritura segura para los archivos de configuración del agente:

  • AGENTS.md — Se crea solo si no existe
  • CLAUDE.md — Se crea solo si no existe
  • GEMINI.md — Se crea solo si no existe
  • COPILOT.md — Se crea solo si no existe
  • GOOSE.md — Se crea solo si no existe
  • PI.md — Se crea solo si no existe

Tus personalizaciones siempre se conservan.


Compatibilidad Multiagente

PlataformaFormato de ManifiestoRuta de Instalación
Claude Code.claude-plugin/plugin.json~/.claude/plugins/engineering-docs/
Gemini CLIintegrations/plugins/gemini-extension.json~/.gemini/config/plugins/engineering-docs/
Cursor / Windsurfintegrations/plugins/.cursor-plugin/plugin.json./.cursor/rules/engineering-docs-*.mdc
Kimi Codeintegrations/plugins/.kimi-plugin/plugin.json~/.kimi-code/plugins/engineering-docs/
Codexintegrations/plugins/.codex-plugin/plugin.json./.codex/engineering-docs/
OpenCodeintegrations/plugins/.opencode/plugin.json./.opencode/engineering-docs/
Gooseintegrations/plugins/.goose/GOOSE.md~/.config/goose/extensions/engineering-docs/
Piintegrations/plugins/.pi/PI.md~/.pi/packages/engineering-docs/
Kilo Codeintegrations/plugins/.kilo-plugin/plugin.json~/.kilo-code/plugins/engineering-docs/
Roo Codeintegrations/plugins/.roo-plugin/plugin.json~/.roo-code/plugins/engineering-docs/
Clineintegrations/plugins/.cline/.clinerules./.clinerules
Factory Droidintegrations/plugins/.factory-plugin/plugin.json~/.factory/plugins/engineering-docs/
Copilot CLIintegrations/plugins/.copilot/COPILOT.md~/.copilot/plugins/engineering-docs/

Pruebas

# Run plugin validation
claude plugin validate .

# Run skill tests
npm test

# Test MCP server
node scripts/validate.js

Filosofía

  • Sistémico sobre Ad-hoc — Los procesos rigurosos y reproducibles producen software más seguro y limpio
  • Trazabilidad — Cada requisito se vincula a un objetivo de negocio y un caso de prueba
  • Visual primero — Arquitecturas complejas mapeadas con diagramas Mermaid rastreables en Git
  • Seguridad operativa — Ninguna funcionalidad está completa sin hoja de ruta de implementación, monitoreo y reversión
  • Aprendizaje sin culpas — Los fallos de producción son puntos de datos para el endurecimiento del sistema

Contribuciones

¡Damos la bienvenida a habilidades de la comunidad! Por favor, revisa CONTRIBUTING.md para las directrices.


Comunidad


Autor


Licencia

MIT. Consulta LICENSE.