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>
This commit is contained in:
@@ -0,0 +1,70 @@
|
||||
# Context & Working Relationship
|
||||
|
||||
**Step:** Phase 0 - Project Setup
|
||||
**Completed:** {{date}}
|
||||
**Session:** {{session_number}}
|
||||
|
||||
---
|
||||
|
||||
## Project Metadata
|
||||
|
||||
**Project Name:** {{project_name}}
|
||||
**Project Slug:** {{project_slug}}
|
||||
**Product Type:** {{website|web_app|mobile_app|landing_page}}
|
||||
**Industry:** {{industry}}
|
||||
|
||||
---
|
||||
|
||||
## Working Relationship Context
|
||||
|
||||
### Stakes
|
||||
**Level:** {{personal|business|departmental|enterprise}}
|
||||
|
||||
**What this means:**
|
||||
{{explanation_of_stakes}}
|
||||
|
||||
**Stakeholders (if applicable):**
|
||||
{{stakeholder_list_or_none}}
|
||||
|
||||
**Political Sensitivities (if applicable):**
|
||||
{{sensitivities_or_none}}
|
||||
|
||||
---
|
||||
|
||||
### Collaboration Style
|
||||
|
||||
**Involvement Level:** {{collaborative|balanced|autonomous}}
|
||||
**User Role:** {{role_description}}
|
||||
**Recommendation Style:** {{options|recommend|direct}}
|
||||
|
||||
**What this means for our work:**
|
||||
{{how_this_shapes_collaboration}}
|
||||
|
||||
---
|
||||
|
||||
### Documentation Approach
|
||||
|
||||
**Documentation Needs:** {{minimal|standard|comprehensive}}
|
||||
**Justification Level:** {{trust_based|balanced|evidence_based}}
|
||||
|
||||
**Adapted approach:**
|
||||
- Tone: {{tone_description}}
|
||||
- Detail level: {{detail_level}}
|
||||
- Evidence requirements: {{evidence_approach}}
|
||||
|
||||
---
|
||||
|
||||
## Project Configuration
|
||||
|
||||
**Brief Level:** {{complete|simplified}}
|
||||
**Strategic Analysis:** {{full|simplified|skip}}
|
||||
**Skip Design System:** {{yes|no}}
|
||||
**Skip Trigger Map:** {{yes|no}}
|
||||
|
||||
**Product Complexity:** {{simple|standard|complex}}
|
||||
**Tech Stack:** {{tech_stack_or_tbd}}
|
||||
**Component Library:** {{library_or_tbd}}
|
||||
|
||||
---
|
||||
|
||||
**Documented in:** `wds-project-outline.yaml` (frontmatter)
|
||||
@@ -0,0 +1,85 @@
|
||||
# Step 2: Vision Capture
|
||||
|
||||
**Completed:** {{date}}
|
||||
**Session:** {{session_number}}
|
||||
**Substeps:** 01-open-conversation → 02-explore-vision → 03-reflect-confirm → 04-synthesize-document
|
||||
|
||||
---
|
||||
|
||||
## Opening Question
|
||||
|
||||
**Agent asked:**
|
||||
{{opening_question_adapted_to_context}}
|
||||
|
||||
**User's initial response:**
|
||||
{{first_response}}
|
||||
|
||||
---
|
||||
|
||||
## Conversation Highlights
|
||||
|
||||
### Key Exchange 1
|
||||
**Agent:** {{question_or_followup}}
|
||||
**User:** {{response}}
|
||||
**Signal detected:** {{signal_type}} — {{what_this_revealed}}
|
||||
|
||||
### Key Exchange 2
|
||||
**Agent:** {{question_or_followup}}
|
||||
**User:** {{response}}
|
||||
**Signal detected:** {{signal_type}} — {{what_this_revealed}}
|
||||
|
||||
### Key Exchange 3
|
||||
**Agent:** {{question_or_followup}}
|
||||
**User:** {{response}}
|
||||
**Signal detected:** {{signal_type}} — {{what_this_revealed}}
|
||||
|
||||
---
|
||||
|
||||
## Conversation Flow Summary
|
||||
|
||||
{{narrative_summary_of_conversation}}
|
||||
|
||||
**Total exchanges:** {{count}}
|
||||
**Duration:** {{approximate_time}}
|
||||
|
||||
---
|
||||
|
||||
## Reflection Checkpoint
|
||||
|
||||
**Agent's synthesis (2-3 sentences):**
|
||||
{{what_im_hearing_is}}
|
||||
|
||||
**User response:**
|
||||
- [x] Confirmed
|
||||
- [ ] Corrected
|
||||
|
||||
**Corrections (if any):**
|
||||
{{what_was_misunderstood_and_corrected}}
|
||||
|
||||
---
|
||||
|
||||
## Synthesized Vision
|
||||
|
||||
{{vision_statement}}
|
||||
|
||||
---
|
||||
|
||||
## Key Insights Captured
|
||||
|
||||
1. {{insight_1}}
|
||||
2. {{insight_2}}
|
||||
3. {{insight_3}}
|
||||
|
||||
---
|
||||
|
||||
## Example Context (if applicable)
|
||||
|
||||
**Concrete example provided:**
|
||||
{{example_scenario_or_none}}
|
||||
|
||||
This example shaped understanding of: {{what_example_clarified}}
|
||||
|
||||
---
|
||||
|
||||
**Documented in:** `wds-project-outline.yaml` → `vision`
|
||||
**Referenced in:** Product Brief documentation
|
||||
@@ -0,0 +1,82 @@
|
||||
# Step 3: User Definition
|
||||
|
||||
**Completed:** {{date}}
|
||||
**Session:** {{session_number}}
|
||||
|
||||
---
|
||||
|
||||
## Opening Question
|
||||
|
||||
**Agent asked:**
|
||||
{{opening_question_about_users}}
|
||||
|
||||
**User's initial response:**
|
||||
{{first_response}}
|
||||
|
||||
---
|
||||
|
||||
## User Exploration
|
||||
|
||||
### Primary User Discovery
|
||||
|
||||
**Key exchanges:**
|
||||
|
||||
**Agent:** {{followup_question}}
|
||||
**User:** {{response}}
|
||||
|
||||
**Agent:** {{deeper_question}}
|
||||
**User:** {{response}}
|
||||
|
||||
**Agent:** {{clarifying_question}}
|
||||
**User:** {{response}}
|
||||
|
||||
---
|
||||
|
||||
## Reflection Checkpoint
|
||||
|
||||
**Agent's synthesis:**
|
||||
{{understanding_of_primary_user}}
|
||||
|
||||
**User response:**
|
||||
- [ ] Confirmed
|
||||
- [ ] Corrected
|
||||
|
||||
**Corrections (if any):**
|
||||
{{corrections}}
|
||||
|
||||
---
|
||||
|
||||
## Primary User Definition
|
||||
|
||||
**Who they are:**
|
||||
{{user_description}}
|
||||
|
||||
**Their context:**
|
||||
{{situation_and_environment}}
|
||||
|
||||
**Their frustrations:**
|
||||
{{pain_points}}
|
||||
|
||||
**What they're trying to achieve:**
|
||||
{{goals_and_jobs_to_be_done}}
|
||||
|
||||
**How they currently solve this:**
|
||||
{{current_alternatives}}
|
||||
|
||||
---
|
||||
|
||||
## Secondary Users (if applicable)
|
||||
|
||||
**User 2:** {{description_or_none}}
|
||||
**User 3:** {{description_or_none}}
|
||||
|
||||
---
|
||||
|
||||
## User Scenarios Captured
|
||||
|
||||
**Scenario 1:** {{concrete_example}}
|
||||
**Scenario 2:** {{concrete_example}}
|
||||
|
||||
---
|
||||
|
||||
**Documented in:** `wds-project-outline.yaml` → `users`
|
||||
@@ -0,0 +1,82 @@
|
||||
# Step 4: Product Concept
|
||||
|
||||
**Completed:** {{date}}
|
||||
**Session:** {{session_number}}
|
||||
|
||||
---
|
||||
|
||||
## Purpose
|
||||
|
||||
Capture the designer's STRUCTURAL vision - the founding principle or key feature that defines the product concept.
|
||||
|
||||
**Not just requirements - the IDEA.**
|
||||
|
||||
---
|
||||
|
||||
## Concept Exploration
|
||||
|
||||
**Agent asked:**
|
||||
{{question_to_surface_concept}}
|
||||
|
||||
**User described:**
|
||||
{{concept_description}}
|
||||
|
||||
---
|
||||
|
||||
## Deep Dive
|
||||
|
||||
### Core Structural Idea
|
||||
|
||||
**The founding principle:**
|
||||
{{what_makes_this_product_distinct}}
|
||||
|
||||
**Concrete example:**
|
||||
{{specific_example_of_concept_in_action}}
|
||||
|
||||
### Why This Matters
|
||||
|
||||
**User's rationale:**
|
||||
{{why_this_approach}}
|
||||
|
||||
**Problem it solves:**
|
||||
{{what_this_enables}}
|
||||
|
||||
---
|
||||
|
||||
## Reflection Checkpoint
|
||||
|
||||
**Agent's synthesis:**
|
||||
{{understanding_of_concept}}
|
||||
|
||||
**User response:**
|
||||
- [ ] Confirmed
|
||||
- [ ] Corrected
|
||||
|
||||
**Corrections (if any):**
|
||||
{{corrections}}
|
||||
|
||||
---
|
||||
|
||||
## Concept Documentation
|
||||
|
||||
**Core concept:**
|
||||
{{concept_statement}}
|
||||
|
||||
**Implementation principle:**
|
||||
{{how_this_shapes_design}}
|
||||
|
||||
**Example:** {{concrete_example}}
|
||||
|
||||
---
|
||||
|
||||
## Related Features
|
||||
|
||||
Features that stem from this concept:
|
||||
1. {{feature_1}}
|
||||
2. {{feature_2}}
|
||||
3. {{feature_3}}
|
||||
|
||||
---
|
||||
|
||||
**Documented in:** `wds-project-outline.yaml` → `product_concept`
|
||||
**Impacts:** Navigation structure, information architecture, feature priorities
|
||||
@@ -0,0 +1,72 @@
|
||||
# Step 6: Inspiration & References
|
||||
|
||||
**Completed:** {{date}}
|
||||
**Session:** {{session_number}}
|
||||
|
||||
---
|
||||
|
||||
## Visual Preference Exploration
|
||||
|
||||
### What User Likes
|
||||
|
||||
**Reference 1:** {{site_or_example}}
|
||||
**What they like:** {{specific_elements}}
|
||||
**Why it resonates:** {{reason}}
|
||||
|
||||
**Reference 2:** {{site_or_example}}
|
||||
**What they like:** {{specific_elements}}
|
||||
**Why it resonates:** {{reason}}
|
||||
|
||||
**Reference 3:** {{site_or_example}}
|
||||
**What they like:** {{specific_elements}}
|
||||
**Why it resonates:** {{reason}}
|
||||
|
||||
---
|
||||
|
||||
### What User Dislikes
|
||||
|
||||
**Reference 1:** {{site_or_example}}
|
||||
**What to avoid:** {{specific_elements}}
|
||||
**Why it doesn't work:** {{reason}}
|
||||
|
||||
**Reference 2:** {{site_or_example}}
|
||||
**What to avoid:** {{specific_elements}}
|
||||
**Why it doesn't work:** {{reason}}
|
||||
|
||||
---
|
||||
|
||||
## Style Preferences
|
||||
|
||||
**Overall aesthetic:** {{description}}
|
||||
**Color preferences:** {{notes}}
|
||||
**Tone/mood:** {{description}}
|
||||
**Level of complexity:** {{simple|balanced|rich}}
|
||||
|
||||
---
|
||||
|
||||
## Competitor Analysis (if discussed)
|
||||
|
||||
**Competitor 1:** {{name}}
|
||||
- What they do well: {{strengths}}
|
||||
- Where they fall short: {{weaknesses}}
|
||||
- How we'll differentiate: {{approach}}
|
||||
|
||||
**Competitor 2:** {{name}}
|
||||
- What they do well: {{strengths}}
|
||||
- Where they fall short: {{weaknesses}}
|
||||
- How we'll differentiate: {{approach}}
|
||||
|
||||
---
|
||||
|
||||
## Reference Material Collected
|
||||
|
||||
- [{{name}}]({{url}}) — {{what_to_extract}}
|
||||
- [{{name}}]({{url}}) — {{what_to_extract}}
|
||||
- [{{name}}]({{url}}) — {{what_to_extract}}
|
||||
|
||||
---
|
||||
|
||||
**Documented in:**
|
||||
- `inspiration/visual-refs.md`
|
||||
- `inspiration/competitor-analysis.md`
|
||||
- `wds-project-outline.yaml` → `inspiration`
|
||||
@@ -0,0 +1,86 @@
|
||||
# Step 7: Positioning
|
||||
|
||||
**Completed:** {{date}}
|
||||
**Session:** {{session_number}}
|
||||
|
||||
---
|
||||
|
||||
## Positioning Exploration
|
||||
|
||||
**Agent asked:**
|
||||
{{opening_question_about_positioning}}
|
||||
|
||||
**User's initial response:**
|
||||
{{first_response}}
|
||||
|
||||
---
|
||||
|
||||
## Key Exchanges
|
||||
|
||||
### Differentiation
|
||||
|
||||
**Agent:** {{question_about_difference}}
|
||||
**User:** {{response}}
|
||||
|
||||
**What this revealed:**
|
||||
{{insight_about_unique_angle}}
|
||||
|
||||
---
|
||||
|
||||
### Market Context
|
||||
|
||||
**Agent:** {{question_about_alternatives}}
|
||||
**User:** {{response}}
|
||||
|
||||
**What this revealed:**
|
||||
{{insight_about_competitive_landscape}}
|
||||
|
||||
---
|
||||
|
||||
### Value Proposition
|
||||
|
||||
**Agent:** {{question_about_value}}
|
||||
**User:** {{response}}
|
||||
|
||||
**What this revealed:**
|
||||
{{insight_about_core_value}}
|
||||
|
||||
---
|
||||
|
||||
## Reflection Checkpoint
|
||||
|
||||
**Agent's synthesis:**
|
||||
{{positioning_understanding}}
|
||||
|
||||
**User response:**
|
||||
- [ ] Confirmed
|
||||
- [ ] Corrected
|
||||
|
||||
**Corrections (if any):**
|
||||
{{corrections}}
|
||||
|
||||
---
|
||||
|
||||
## Positioning Statement
|
||||
|
||||
{{positioning_statement}}
|
||||
|
||||
**For:** {{target_user}}
|
||||
**Who:** {{their_situation}}
|
||||
**This product:** {{what_it_is}}
|
||||
**That:** {{key_benefit}}
|
||||
**Unlike:** {{alternatives}}
|
||||
**Our approach:** {{differentiation}}
|
||||
|
||||
---
|
||||
|
||||
## Supporting Evidence
|
||||
|
||||
**Why this position makes sense:**
|
||||
1. {{rationale_1}}
|
||||
2. {{rationale_2}}
|
||||
3. {{rationale_3}}
|
||||
|
||||
---
|
||||
|
||||
**Documented in:** `wds-project-outline.yaml` → `positioning`
|
||||
@@ -0,0 +1,81 @@
|
||||
# Dialog Template Usage
|
||||
|
||||
## Quick Start
|
||||
|
||||
**Copy to project:**
|
||||
```bash
|
||||
cp -r workflows/1-project-brief/templates/project-brief-dialog projects/{{slug}}/dialog
|
||||
```
|
||||
|
||||
**Update as you progress:**
|
||||
- Complete each file when the corresponding PB step finishes
|
||||
- Update README.md progress tracker
|
||||
- Append to decisions.md whenever key decisions are made
|
||||
|
||||
---
|
||||
|
||||
## What to Capture
|
||||
|
||||
### DO:
|
||||
- Key questions + user responses (not full transcript)
|
||||
- Signal-based follow-ups that revealed insights
|
||||
- Reflection checkpoint (synthesis + confirmation + corrections)
|
||||
- Final outputs (vision, positioning, etc.)
|
||||
- WHY decisions were made
|
||||
|
||||
### DON'T:
|
||||
- Verbatim transcripts
|
||||
- Procedural agent actions
|
||||
- Implementation details
|
||||
- Repetitive exchanges
|
||||
|
||||
---
|
||||
|
||||
## Mandatory Checkpoints
|
||||
|
||||
**Document EVERY reflection:**
|
||||
1. Agent's synthesis (2-3 sentences)
|
||||
2. User confirmed or corrected?
|
||||
3. What was misunderstood? (if corrected)
|
||||
|
||||
---
|
||||
|
||||
## Integration with Steps
|
||||
|
||||
**Each step file should mandate:**
|
||||
|
||||
```markdown
|
||||
## Design Log Update
|
||||
|
||||
Before marking complete:
|
||||
1. Update `dialog/{{step}}-{{name}}.md`
|
||||
2. Document reflection checkpoint
|
||||
3. Record final synthesis
|
||||
4. Mark complete in `dialog/README.md`
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## File Sizes
|
||||
|
||||
All dialog files: 65-86 lines (well under 100-line target)
|
||||
|
||||
---
|
||||
|
||||
## Design Log (Meta-Level)
|
||||
|
||||
**For multi-session work**, agents should use the design log for state tracking and `_progress/agent-experiences/` for session insights.
|
||||
|
||||
**Location:** `{{root_folder}}/_progress/00-design-log.md`
|
||||
|
||||
**Update Protocol:**
|
||||
1. Complete current task
|
||||
2. Update design log with changes
|
||||
3. Show git diff to user
|
||||
4. Record session insights in `_progress/agent-experiences/` if needed
|
||||
|
||||
---
|
||||
|
||||
## Purpose
|
||||
|
||||
Create transparent record of discovery conversations so future agents (and humans) understand WHY decisions were made, not just WHAT was decided. The design log provides this continuity across sessions.
|
||||
@@ -0,0 +1,85 @@
|
||||
# Key Decisions Log
|
||||
|
||||
**Project:** {{project_name}}
|
||||
**Format:** Append-only decision log
|
||||
|
||||
---
|
||||
|
||||
## Decision 1: {{decision_topic}}
|
||||
|
||||
**Date:** {{date}}
|
||||
**Step:** {{step_where_decided}}
|
||||
**Session:** {{session_number}}
|
||||
|
||||
**Context:**
|
||||
{{what_prompted_this_decision}}
|
||||
|
||||
**What was decided:**
|
||||
{{the_decision}}
|
||||
|
||||
**Why:**
|
||||
{{rationale}}
|
||||
|
||||
**Impact:**
|
||||
{{how_this_shapes_project}}
|
||||
|
||||
**Alternatives considered:**
|
||||
- {{option_1}} — {{why_not}}
|
||||
- {{option_2}} — {{why_not}}
|
||||
|
||||
**Documented in:** {{file_path}}
|
||||
|
||||
---
|
||||
|
||||
## Decision 2: {{decision_topic}}
|
||||
|
||||
**Date:** {{date}}
|
||||
**Step:** {{step_where_decided}}
|
||||
**Session:** {{session_number}}
|
||||
|
||||
**Context:**
|
||||
{{what_prompted_this_decision}}
|
||||
|
||||
**What was decided:**
|
||||
{{the_decision}}
|
||||
|
||||
**Why:**
|
||||
{{rationale}}
|
||||
|
||||
**Impact:**
|
||||
{{how_this_shapes_project}}
|
||||
|
||||
**Alternatives considered:**
|
||||
- {{option_1}} — {{why_not}}
|
||||
- {{option_2}} — {{why_not}}
|
||||
|
||||
**Documented in:** {{file_path}}
|
||||
|
||||
---
|
||||
|
||||
## Decision 3: {{decision_topic}}
|
||||
|
||||
**Date:** {{date}}
|
||||
**Step:** {{step_where_decided}}
|
||||
**Session:** {{session_number}}
|
||||
|
||||
**Context:**
|
||||
{{what_prompted_this_decision}}
|
||||
|
||||
**What was decided:**
|
||||
{{the_decision}}
|
||||
|
||||
**Why:**
|
||||
{{rationale}}
|
||||
|
||||
**Impact:**
|
||||
{{how_this_shapes_project}}
|
||||
|
||||
**Alternatives considered:**
|
||||
- {{option_1}} — {{why_not}}
|
||||
|
||||
**Documented in:** {{file_path}}
|
||||
|
||||
---
|
||||
|
||||
_Continue appending decisions as they're made throughout the Product Brief process._
|
||||
@@ -0,0 +1,76 @@
|
||||
# Product Brief Dialog: {{project_name}}
|
||||
|
||||
**Agent:** Saga (Product Brief Analyst)
|
||||
**Project:** {{project_name}}
|
||||
**Started:** {{start_date}}
|
||||
**Status:** {{in_progress|completed}}
|
||||
**Last Updated:** {{current_date}}
|
||||
|
||||
---
|
||||
|
||||
## About This Dialog
|
||||
|
||||
This dialog tracks the Product Brief discovery process - the conversations, reflections, decisions, and synthesis that led to the documented brief.
|
||||
|
||||
---
|
||||
|
||||
## Project Context
|
||||
|
||||
**Client/Stakeholder:** {{client_name}} ({{relationship}})
|
||||
**Designer:** {{designer_name}}
|
||||
**Sign-off Authority:** {{who_approves}}
|
||||
**Project Type:** {{internal|external|agency}}
|
||||
|
||||
**Working Relationship:**
|
||||
{{Brief description of stakes, involvement level, how directive to be}}
|
||||
|
||||
---
|
||||
|
||||
## Progress Tracker
|
||||
|
||||
- [ ] [Vision Capture](02-vision.md) — What we're building and why
|
||||
- [ ] [User Definition](03-users.md) — Who we're building for
|
||||
- [ ] [Product Concept](04-concept.md) — The founding structural idea
|
||||
- [ ] [Core Features](05-features.md) — Essential functionality
|
||||
- [ ] [Inspiration & References](06-inspiration.md) — Visual preferences and references
|
||||
- [ ] [Positioning](07-positioning.md) — Market position and differentiation
|
||||
- [ ] [Success Metrics](08-metrics.md) — How we measure success
|
||||
- [ ] [Constraints](09-constraints.md) — Limitations and boundaries
|
||||
- [ ] [Launch Requirements](10-launch.md) — What's needed to ship
|
||||
- [ ] [Timeline & Phases](11-timeline.md) — Roadmap and milestones
|
||||
- [ ] [Review & Synthesis](12-synthesis.md) — Final review and signoff
|
||||
|
||||
---
|
||||
|
||||
## Key Decisions
|
||||
|
||||
See [decisions.md](decisions.md) for detailed decision log.
|
||||
|
||||
**Major decisions:**
|
||||
1. {{decision_summary_1}}
|
||||
2. {{decision_summary_2}}
|
||||
3. {{decision_summary_3}}
|
||||
|
||||
---
|
||||
|
||||
## Reflection Quality
|
||||
|
||||
**Total Checkpoints:** {{count}}
|
||||
**Confirmed First Try:** {{count}}
|
||||
**Required Correction:** {{count}}
|
||||
|
||||
This measures how well the agent understood the user's intent.
|
||||
|
||||
---
|
||||
|
||||
## Dialog Artifacts
|
||||
|
||||
All dialog files are timestamped and track the natural conversation flow, not just the final outputs.
|
||||
|
||||
**Purpose:** Enable future agents (or humans) to understand WHY decisions were made, not just WHAT was decided.
|
||||
|
||||
---
|
||||
|
||||
**Generated Artifacts:**
|
||||
- [wds-project-outline.yaml](../../projects/{{project_slug}}/wds-project-outline.yaml)
|
||||
- [Product Brief documentation](../../projects/{{project_slug}}/A-Product-Brief/)
|
||||
Reference in New Issue
Block a user