ai-flow-dev 2.1.3 → 2.1.4

package/prompts/backend/flow-docs-sync.md

@@ -3,17 +3,13 @@
 **YOU ARE AN EXPERT TECHNICAL ARCHITECT AND DOCUMENTATION SPECIALIST.**
 
 Your mission is to detect changes in the codebase and update the project documentation automatically when the user executes `/flow-docs-sync`.
-
----
-
+---
 ## Command: `/flow-docs-sync`
 
 ### Objective
 
 Detect changes in the codebase compared to the last documented state (stored in `.ai-flow/cache/docs-analysis.json`) and update all affected documentation files automatically.
-
----
-
+---
 ## Execution Flow
 
 ### Step 1: Check for Analysis File
@@ -82,193 +78,28 @@ First, check if `.ai-flow/cache/docs-analysis.json` exists:
 
 No se requiere ninguna actualización.
 ```
-
----
-
+---
 ## 📊 MERMAID DIAGRAM REGENERATION GUIDELINES
 
-When regenerating or updating diagrams in documentation files, follow these **critical** formatting rules:
+> 📎 **Reference:** See [prompts/shared/mermaid-guidelines.md](../shared/mermaid-guidelines.md) for all Mermaid diagram formatting rules (ER, Architecture, Flow).
 
 ### ER Diagrams (data-model.md)
 
-**Diagram Type:** `erDiagram`
-
-**Requirements:**
-
-1. Show ALL entities and their relationships
-2. Include field types and constraints (PK, FK, UK)
-3. Add descriptions for complex or business-critical fields
-4. Verify relationship cardinality matches actual database schema
-5. Keep entity order logical (core entities first, then related)
-
-**Quality Checklist:**
-
-- [ ] Code fence is exactly ` ```mermaid ` (lowercase, no spaces)
-- [ ] All entities from database are represented
-- [ ] All foreign key relationships are shown
-- [ ] Primary keys are marked with `PK`
-- [ ] Foreign keys are marked with `FK`
-- [ ] Many-to-many relationships use junction tables
-- [ ] Field types match database schema
-- [ ] Diagram renders without errors
-
-**Example:**
-
-````markdown
-```mermaid
-erDiagram
-    USER ||--o{ ORDER : places
-    PRODUCT ||--o{ ORDER_ITEM : contains
-    ORDER ||--o{ ORDER_ITEM : includes
-
-    USER {
-        string id PK
-        string email UK
-        string name
-        datetime createdAt
-    }
-
-    ORDER {
-        string id PK
-        string userId FK
-        decimal total
-        string status
-    }
-
-    PRODUCT {
-        string id PK
-        string name
-        decimal price
-    }
-
-    ORDER_ITEM {
-        string id PK
-        string orderId FK
-        string productId FK
-        int quantity
-    }
-```
-````
-
----
-
+> 📎 **Reference:** See [prompts/shared/mermaid-guidelines.md](../shared/mermaid-guidelines.md) for ER diagram syntax, relationship notation, and common mistakes.
+---
 ### Architecture Diagrams (architecture.md)
 
-**Diagram Type:** `graph TD` (or `graph LR`)
-
-**Requirements:**
-
-1. Show ALL major system components (services, databases, caches, queues)
-2. Label connections with protocols/methods (HTTPS, gRPC, REST, etc.)
-3. Use consistent styling (databases as cylinders, services as boxes)
-4. Include external integrations (Email, Payment, SMS services)
-5. Show monitoring and logging components if present
-6. Include deployment context (load balancers, CDN) if relevant
-
-**Quality Checklist:**
-
-- [ ] Code fence is exactly ` ```mermaid ` (lowercase, no spaces)
-- [ ] All services/components from codebase are shown
-- [ ] Database connections are labeled
-- [ ] External APIs are included
-- [ ] Authentication/authorization flow is visible
-- [ ] Caching layer is shown (if exists)
-- [ ] Message queues are included (if exists)
-- [ ] Styling is applied for clarity
-- [ ] Diagram renders without errors
-
-**Example:**
-
-````markdown
-```mermaid
-graph TD
-    Client[Client Application]
-    API[API Gateway<br/>Express/NestJS]
-    Auth[Auth Service<br/>JWT]
-    DB[(PostgreSQL)]
-    Cache[(Redis)]
-    Queue[Message Queue<br/>RabbitMQ]
-
-    Client -->|HTTPS| API
-    API -->|Verify| Auth
-    API -->|Query| DB
-    API -->|Cache| Cache
-    API -->|Enqueue| Queue
-
-    style DB fill:#e1ffe1
-    style Cache fill:#f0e1ff
-```
-````
-
----
-
+> 📎 **Reference:** See [prompts/shared/mermaid-guidelines.md](../shared/mermaid-guidelines.md) for architecture diagram syntax, node shapes, and styling.
+---
+---
 ### Business Flow Diagrams (project-brief.md)
 
-**Diagram Type:** `flowchart TD` (or `flowchart LR`)
-
-**Requirements:**
-
-1. Start with `([Start Terminal])`
-2. End with `([End Terminal])`
-3. Use `{Diamond}` for ALL decision points
-4. Label ALL decision branches clearly (`-->|Yes|`, `-->|No|`)
-5. Show complete paths (including error/failure scenarios)
-6. Keep flows readable (avoid crossing arrows when possible)
-7. Use consistent styling for node types
-
-**Quality Checklist:**
-
-- [ ] Code fence is exactly ` ```mermaid ` (lowercase, no spaces)
-- [ ] Flow starts with a terminal node
-- [ ] Flow ends with terminal node(s)
-- [ ] All decision points have labeled branches
-- [ ] All paths lead to an end state
-- [ ] Error/failure paths are included
-- [ ] Node labels are clear and concise
-- [ ] Line breaks (`<br/>`) used for readability
-- [ ] Styling applied for visual clarity
-- [ ] Diagram renders without errors
-
-**Example:**
-
-````markdown
-```mermaid
-flowchart TD
-    Start([User Starts Process]) --> Action1[Perform Action]
-    Action1 --> Decision{Success?}
-
-    Decision -->|Yes| Success[Process Complete]
-    Decision -->|No| Retry{Retry?}
-
-    Retry -->|Yes| Action1
-    Retry -->|No| Failed[Process Failed]
-
-    Success --> End1([End: Success])
-    Failed --> End2([End: Failed])
-
-    style Start fill:#e1f5ff
-    style End1 fill:#e1ffe1
-    style End2 fill:#ffe1e1
-```
-````
-
----
-
+> 📎 **Reference:** See [prompts/shared/mermaid-guidelines.md](../shared/mermaid-guidelines.md) for business flow syntax, decision points, and styling.
+---
 ### Common Formatting Rules (ALL Diagrams)
 
-**CRITICAL - Code Fence Syntax:**
-
-````
-✅ CORRECT: ```mermaid
-❌ WRONG:   ```Mermaid (capital M)
-❌ WRONG:   ``` mermaid (extra space)
-❌ WRONG:   ``mermaid (missing backtick)
-````
-
-**Indentation:**
-
-- Start Mermaid syntax at column 0 (no leading spaces/tabs)
-- Only indent within Mermaid syntax according to Mermaid rules
+> 📎 **Reference:** See [prompts/shared/mermaid-guidelines.md](../shared/mermaid-guidelines.md) for critical code fence syntax and indentation rules.
+---
 - Do NOT indent the entire code block
 
 **Validation Steps:**
@@ -287,9 +118,7 @@ flowchart TD
 4. Add new elements in logical positions
 5. Preserve comments or notes if present
 6. Verify the entire diagram still renders after changes
-
----
-
+---
 ### Step 4: Update Documents (If User Confirms)
 
 **If user responds "Y", "Yes", "y", "yes", or similar:**
@@ -372,9 +201,7 @@ flowchart TD
 ```
 Actualización cancelada. Ejecuta `/flow-docs-sync` cuando estés listo para actualizar la documentación.
 ```
-
----
-
+---
 ## Change Detection Rules
 
 ### Endpoints Detection
@@ -453,9 +280,7 @@ Actualización cancelada. Ejecuta `/flow-docs-sync` cuando estés listo para act
 - Add new variables to configuration spec
 - Add examples to `.env.example`
 - Maintain existing variables
-
----
-
+---
 ## Important Rules
 
 1. **Incremental Updates Only:**
@@ -482,9 +307,7 @@ Actualización cancelada. Ejecuta `/flow-docs-sync` cuando estés listo para act
    - If document doesn't exist, create it following template
    - If docs-analysis.json is corrupted, regenerate it
    - If comparison fails, show error and suggest full Phase 0 re-run
-
----
-
+---
 ## Example Execution
 
 ```
@@ -518,7 +341,8 @@ AI:
 
 Documentación sincronizada exitosamente.
 ```
+---
+**BEGIN EXECUTION when user runs `/flow-docs-sync`**
+
 
----
 
-**BEGIN EXECUTION when user runs `/flow-docs-sync`**