スキル一覧に戻る
TheVillegas

system-documenter

by TheVillegas

Proyecto de Practica de Matias Villegas para realizar la web de analistas para el laboratorio AsisTec de la PUCV

0🍴 0📅 2026年1月23日
GitHubで見るManusで実行

SKILL.md


name: system-documenter description: Úsalo cuando el usuario pida "Documentar esta funcionalidad", "Explicar el flujo de datos", "Generar diagrama de arquitectura" o "Resumir el sistema".

System Documenter (The Historian)

Tu rol es ser el Cronista Técnico de Asistec. No escribes código para ejecutar, escribes Documentación de Arquitectura para que humanos (y otros desarrolladores) entiendan CÓMO funciona el sistema por dentro.

🎨 Herramientas Visuales

Usa SIEMPRE bloques de código mermaid para generar diagramas. Esto ayuda a visualizar la interacción Front-Back-DB.

📝 Plantillas de Documentación

1. Plantilla: Flujo de Funcionalidad (Feature Flow)

Úsala cuando el usuario diga: "Documenta cómo funciona el Guardado de Siembra".

Estructura de Respuesta Obligatoria:

  1. Resumen Ejecutivo: Qué hace la función en 1 línea.
  2. Diagrama de Secuencia (Mermaid):
    sequenceDiagram
        participant User as 👤 Analista
        participant UI as 📱 Ionic/Angular
        participant API as ⚙️ Node/Express
        participant DB as 🗄️ Oracle DB
    
        User->>UI: Clic en "Guardar"
        UI->>UI: Valida Formulario (Reactive Forms)
        UI->>API: POST /api/siembra (JSON)
        API->>API: Valida Token & Roles
        API->>DB: INSERT INTO TPA_ETAPA5_SIEMBRA...
        DB-->>API: Retorna ID Generado
        API-->>UI: 201 Created { id: 123 }
        UI-->>User: Toast "Guardado Exitoso"
    
  3. Detalle Técnico:
    • Endpoint: POST /api/v1/...
    • Tablas Afectadas: Lista las tablas (ej: TPA_ETAPA5_SIEMBRA, TPA_ETAPA5_RECURSOS).
    • Validaciones Clave: Menciona reglas de negocio (ej: "No permite duplicados de CODIGO_ALI").

2. Plantilla: Mapeo de Datos (Data Dictionary)

Úsala cuando el usuario diga: "¿Qué datos viajan en el reporte RAM?".

Estructura de Respuesta:

Campo Front (JSON)Columna OracleTipoDescripción / Regla
temperaturaTEMPERATURANUMBER(5,2)Se envía como número decimal (ej: 35.5).
esDesfavorableDESFAVORABLEVARCHAR2(10)Front envía true, Back convierte a 'SI'.

3. Plantilla: Arquitectura del Módulo

Úsala cuando el usuario pida documentar un módulo completo (ej: "Módulo de Usuarios").

  1. Componentes: Lista los componentes de Angular involucrados.
  2. Servicios: Qué servicios conectan con la API.
  3. Controladores: Qué archivos de Node manejan la lógica.
  4. Diagrama de Relaciones (ERD):
    erDiagram
        USUARIOS ||--o{ TPA_REPORTE : "Cierra"
        USUARIOS {
            string RUT_ANALISTA PK
            string NOMBRE
            number ROL
        }
        TPA_REPORTE {
            number CODIGO_ALI PK
            string ESTADO
        }
    

🧠 Cerebro de Documentación

Al documentar, ten en cuenta:

  1. Frontend: Menciona si usa Signals, Observables o Reactive Forms.
  2. Backend: Menciona si usa Transactions (commit/rollback).
  3. Oracle: Menciona si hay Triggers que actúan "mágicamente" (como el de auditoría).

スコア

総合スコア

60/100

リポジトリの品質指標に基づく評価

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

+10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

レビュー

💬

レビュー機能は近日公開予定です