Files

Cassel 647cbec54f docs: update all documentation and add AI tooling configs

- Rewrite README.md with current architecture, features and stack
- Update docs/API.md with all current endpoints (corporate, BI, client 360)
- Update docs/ARCHITECTURE.md with cache, modular queries, services, ETL
- Update docs/GUIA-USUARIO.md for all roles (admin, corporate, agente)
- Add docs/INDEX.md documentation index
- Add PROJETO.md comprehensive project reference
- Add BI-CCC-Implementation-Guide.md
- Include AI agent configs (.claude, .agents, .gemini, _bmad)
- Add netbird VPN configuration
- Add status report

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

2026-03-19 13:29:03 -04:00

2.4 KiB

Raw Blame History

Storyboard Extension

Use when: Page has multiple sketches (multi-step flows, state changes, transitions)

Base: Start with page-specification.template.md

What Changes

1. Add State Flow Overview (before Page Sections)

After Reference Materials, add:

## State Flow Overview

{Brief description of states}

![Overview](Sketches/{page-number}-{page-name}-Overview.jpg)

┌─────────────┐    ┌─────────────┐    ┌─────────────┐
│  STATE 1    │───▶│  STATE 2    │───▶│  STATE 3    │
└─────────────┘    └─────────────┘    └─────────────┘

| State | Name | Visual | Entry | Actions |
|-------|------|--------|-------|---------|
| **1** | {name} | {color/icon} | {trigger} | {actions} |
| **2** | {name} | {color/icon} | {trigger} | {actions} |

2. State 1 = Normal Page Specification

Document State 1 using the standard page spec structure:

Page Sections
Objects with OBJECT IDs
Groups with nested objects

This is the baseline that other states reference.

3. States 2+ = Differences Only

After State 1, add for each additional state:

# State 2: {State Name} — Differences from State 1

![State 2](Sketches/{page-number}-{page-name}-2-{state-name}.jpg)

> **The Story:** {User experience narrative}

| Property | Value |
|----------|-------|
| Purpose | {what this state does} |
| Entry | {trigger from previous state} |
| Previous | State 1 |
| Next | State 3 / {options} |

### Changes from State 1

| OBJECT ID | Change | Details |
|-----------|--------|---------|
| `{existing-id}` | Modified | {what changed} |
| `{existing-id}` | Hidden | {why hidden} |
| `{new-id}` | Added | {new element} |

### State 2 Elements

{Only document NEW objects not in State 1}

#### {New Object}

**OBJECT ID:** `{page-name}-{new-object}`

| Property | Value |
|----------|-------|
| Component | [{Component}]({path}) |
| Translation Key | `{key}` |
| SE | "{text}" |
| EN | "{text}" |

Key Principles

State 1 is baseline — fully documented
States 2+ show only changes — reuse OBJECT IDs
Same IDs across states — booking-detail-header stays the same, just describe what changed
New elements get new IDs — only in the state they first appear

2.4 KiB Raw Blame History