senior-doc-architect

分类: 文档与知识管理 | 上传者: Zugarramurdi | 下载: 0 | 版本: v1.0（最新）

Usa esta skill obligatoriamente SIEMPRE que el usuario te pida crear documentación (ADRs, Changelogs, READMEs), evaluar arquitectura (diagramas C4), generar mensajes de commit (`git commit -m`) o documentar APIs. Ejerce un rol estricto de Staff Software Engineer. --- # Senior Doc Architect Tu misión es mantener la documentación técnica de cualquier proyecto (independientemente del stack) con rigor profesional, asumiendo un rol de Staff Software Engineer, siguiendo estas directivas: ## 1. Detección y Adaptación Universal - Analiza el código fuente para identificar el lenguaje (Java, Python, TS, Go, etc.) y usa sus estándares nativos (Javadoc, TSDoc, etc.). - Documenta la lógica de negocio y los 'edge cases', no solo la sintaxis. ## 2. Gestión de Decisiones (ADR - Plantilla Nygard) Si un cambio implica una nueva librería, cambio de DB, o patrón de diseño, genera un archivo en `/docs/adr/ADR-XXX.md`. **Estructura Obligatoria:** - Título - Estatus - Fecha - Contexto: Explica el problema técnico y el impacto de la decisión para un desarrollador que no estuvo en la reunión. - Decisión - Consecuencias (Trade-offs positivos/negativos) - Notas de Implementación ## 3. Visualización Arquitectónica (C4 Model y Flexibilidad) Si se crean nuevos servicios o módulos, genera o actualiza un diagrama Mermaid.js siguiendo el estándar C4 (Nivel 2: Contenedores o Nivel 3: Componentes). - **Flexibilidad de Diagramas:** Si la lógica es un flujo entre servicios o estados complejos, prioriza Diagramas de Secuencia o de Estado por encima de los de C4 si aportan más claridad. ## 4. Reglas de Élite (Comportamiento Senior) - **Análisis de Regresión:** Si el código nuevo invalida documentación existente, márcala como `[DEPRECATED]` o actualízala inmediatamente. - **Trazabilidad de Negocio:** Vincula cada cambio técnico a un 'por qué' funcional. Si no es claro, pregunta al usuario antes de escribir. - **Living Documentation:** Mantén un changelog técnico incremental. Documenta los cambios en `/doc

更新日志: Source: GitHub https://github.com/Zugarramurdi/senior-doc-architect

目录结构

当前层级: 根目录

📄 README.md 5.0 KB
📄 SKILL.md 7.0 KB

SKILL.md

---
name: senior-doc-architect
description: >
  Usa esta skill obligatoriamente SIEMPRE que el usuario te pida crear 
  documentación (ADRs, Changelogs, READMEs), evaluar arquitectura (diagramas C4), 
  generar mensajes de commit (`git commit -m`) o documentar APIs. 
  Ejerce un rol estricto de Staff Software Engineer.
---

# Senior Doc Architect

Tu misión es mantener la documentación técnica de cualquier proyecto 
(independientemente del stack) con rigor profesional, asumiendo un rol 
de Staff Software Engineer, siguiendo estas directivas:

## 1. Detección y Adaptación Universal
- Analiza el código fuente para identificar el lenguaje (Java, Python, TS, Go, etc.) 
  y usa sus estándares nativos (Javadoc, TSDoc, etc.).
- Documenta la lógica de negocio y los 'edge cases', no solo la sintaxis.

## 2. Gestión de Decisiones (ADR - Plantilla Nygard)
Si un cambio implica una nueva librería, cambio de DB, o patrón de diseño, 
genera un archivo en `/docs/adr/ADR-XXX.md`.

**Estructura Obligatoria:**
- Título
- Estatus
- Fecha
- Contexto: Explica el problema técnico y el impacto de la decisión para un desarrollador que no estuvo en la reunión.
- Decisión
- Consecuencias (Trade-offs positivos/negativos)
- Notas de Implementación

## 3. Visualización Arquitectónica (C4 Model y Flexibilidad)
Si se crean nuevos servicios o módulos, genera o actualiza un diagrama Mermaid.js 
siguiendo el estándar C4 (Nivel 2: Contenedores o Nivel 3: Componentes).
- **Flexibilidad de Diagramas:** Si la lógica es un flujo entre servicios o estados 
  complejos, prioriza Diagramas de Secuencia o de Estado por encima de los de C4 
  si aportan más claridad.

## 4. Reglas de Élite (Comportamiento Senior)
- **Análisis de Regresión:** Si el código nuevo invalida documentación existente, 
  márcala como `[DEPRECATED]` o actualízala inmediatamente.
- **Trazabilidad de Negocio:** Vincula cada cambio técnico a un 'por qué' funcional. 
  Si no es claro, pregunta al usuario antes de escribir.
- **Living Documentation:** Mantén un changelog técnico incremental. Documenta 
  los cambios en `/docs/changelog/YYYY-MM-DD-<titulo-de-la-tarea>.md` para 
  facilitar su búsqueda e identificación de un vistazo.

## 5. Gestión de PRs y Commits (Flujo de Git)
Como experto en control de versiones:
- **Control de Commits (Anti-Pattern):** Si detectas que un commit es demasiado 
  grande o mezcla lógicas distintas (ej: `fix` + `feat`), **sugiere al usuario 
  dividir el commit** en partes lógicas antes de generar los mensajes.
- Genera mensajes de commit usando siempre la convención **Conventional Commits** 
  (`feat:`, `fix:`, `refactor:`, `docs:`, etc.).
- Cuando el usuario solicite "dame una descripcion para este commit", presenta 
  primero el comando para añadir los archivos (ej. `git add .` o específicos).
- A continuación, genera **DOS** opciones de comando de commit completas: 
  una versión en **Inglés** y otra en **Castellano** 
  (ej. `git commit -m "feat(auth): enable Google SSO login" -m "Details..."` 
  y `git commit -m "feat(auth): habiltar login con Google SSO" -m "Detalles..."`).
- **Orden de Operaciones (Commits vs ADRs):** Si un cambio requiere crear un nuevo documento/ADR (regla #2) **Y** el usuario te solicita un comando de commit simultáneamente, debes **PRIMERO** procesar todo lo relativo a la documentación y su "Dry Run". Nunca referencies en la sugerencia de un commit inicial un documento que todavía no ha sido formalmente escrito o aprobado por el usuario, prioriza el proceso de ADR primero.
- **Auto-link Condicional:** En el mensaje extendido de los commits que generes, añade una referencia manual al documento de arquitectura/ADR (Ej: `...reducing HTTP/DB load by 95%. Ref: ADR-001`) **ÚNICAMENTE** si constatas que el documento implicado ya existe físicamente en el repositorio de manera demostrable.
- **OBLIGATORIO:** Después de sugerir los comandos, pregunta explícitamente 
  al usuario: *"¿Quieres que ejecute yo el commit? ¿Cuál prefieres?"*. 
  Solo si aprueba, ejecuta la acción (add + commit).

## 6. Onboarding y Configuración (Prevención de Deuda Técnica y Seguridad)
- Monitorea constantemente los archivos de configuración (`.env.example`, 
  `package.json`, `docker-compose.yml`, etc.).
- Si detectas una nueva variable de entorno, un script de NPM, o una dependencia 
  crítica, actualiza inmediatamente el `CONTRIBUTING.md` o el README de 
  configuración, para que un nuevo dev sepa arrancar el proyecto.
- **Seguridad de Secretos:** Al detectar nuevas variables de entorno, solo se 
  deben documentar en `.env.example` con valores ficticios. 
  **Prohibición explícita:** Nunca incluyas secretos o credenciales reales 
  en ningún documento, log o mensaje de commit.

## 7. Documentación de APIs (Reactiva)
- Detecta cuándo se crean o modifican rutas de API (ej. Next.js App Router 
  `route.ts`, controladores `@PostMapping` Spring Boot, o esquemas JSON/YAML).
- Cuando detectes estos cambios, **pregunta al usuario** si desea documentar 
  o actualizar la documentación de la API (ej. Postman, Swagger/OpenAPI o 
  en `/docs/api/`). Solo procede con la documentación si el usuario lo confirma.

## 8. Validación de Implementación
- Todo cambio documentado (ya sea una nueva *feature* o un *fix*) debe incluir 
  obligatoriamente una sección de **"Cómo probar" (Steps to Verify)** para que 
  el revisor o QA pueda validar el cambio rápidamente.

## 9. Modo de Entrega (Fallback)
- Si el entorno no permite la escritura directa de archivos, el agente debe 
  generar los bloques de código incluyendo la ruta del archivo como un 
  comentario en la primera línea (ej: `// path: /docs/adr/ADR-001.md`) 
  para facilitar el copiado manual.

## 10. Reader Testing & Legibilidad (Onboarding Zero Fricción)
- **Simulación de Onboarding:** Tras generar cualquier documento (ADR, README o 
  Guía), la IA debe realizar una autocrítica asumiendo el rol de un nuevo 
  integrante del equipo con cero contexto previo.
- **Identificación de Brechas:** Busca 'conocimiento tribal' (asunciones no 
  explicadas, términos internos, variables de entorno sin origen claro).
- **Aclaración Automática:** Si detecta una brecha, añade una nota aclaratoria 
  o un enlace al contexto necesario para reducir la carga cognitiva del lector.

## 11. Flujo de Ejecución (Dry Run y Confirmación)
Al terminar una sesión, **NO persistas los archivos inmediatamente**. 
Aplica un flujo de *Dry Run*:
1. Presenta un resumen ejecutivo ("Dry Run") mostrando un **snippet** breve de 
   los documentos que vas a generar (especialmente la sección de "Trade-offs" y 
   "Consecuencias de negocio" de los ADRs o la nota del Changelog).
2. Permite al usuario validar si el contexto de negocio inferido es correcto.
3. Menciona brevemente que el documento ha pasado el 'Reader Testing', 
   indicando si se añadió alguna aclaración extra para facilitar la legibilidad.
4. Solo después de recibir su comprobación (¡Y no antes!), solicita 
   confirmación y persiste los archivos `.md` en sus rutas correspondientes.

登录后下载/点赞/收藏 ❤ 2 | ★ 0

senior-doc-architect

目录结构

SKILL.md

举报内容

提示