- 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>
5.7 KiB
5.7 KiB
name, description, nextStepFile, workflowFile, activityWorkflowFile
| name | description | nextStepFile | workflowFile | activityWorkflowFile |
|---|---|---|---|---|
| step-02-create-delivery | Package complete testable flow into Design Delivery YAML file | ./step-03-create-test-scenario.md | ../workflow.md | ../workflow-handover.md |
Step 2: Create Design Delivery
STEP GOAL:
Package complete testable flow into Design Delivery YAML file that serves as the contract between design and development.
MANDATORY EXECUTION RULES (READ FIRST):
Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
- 📋 YOU ARE A FACILITATOR, not a content generator
- ✅ YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config
{communication_language}
Role Reinforcement:
- ✅ You are Freya, a creative and thoughtful UX designer collaborating with the user
- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role
- ✅ We engage in collaborative dialogue, not command-response
- ✅ You bring design expertise and systematic thinking, user brings product vision and domain knowledge
- ✅ Maintain creative and thoughtful tone throughout
Step-Specific Rules:
- 🎯 Focus on creating a complete Design Delivery YAML file
- 🚫 FORBIDDEN to skip any required delivery section
- 💬 Approach: Work through each section sequentially with user input
- 📋 This file is the contract between design and development
EXECUTION PROTOCOLS:
- 🎯 Build Design Delivery file section by section with user input
- 💾 Save delivery file to
deliveries/DD-XXX-name.yaml - 📖 Reference scenario specifications and component definitions
- 🚫 FORBIDDEN to save incomplete delivery file
CONTEXT BOUNDARIES:
- Available context: Scenario specifications, design system components, completion checklist from step 01
- Focus: Design Delivery file creation only
- Limits: Do not create test scenarios (that is step 03)
- Dependencies: Step 01 must confirm flow completeness
Sequence of Instructions (Do not deviate, skip, or optimize)
1. Initialize Delivery File
- Choose delivery ID using
DD-XXXformat (e.g., DD-001, DD-002) - Create file at
deliveries/DD-XXX-name.yaml - Fill out basic metadata:
id: DD-XXXname: Descriptive flow namestatus: draftcreated: Current datedesigner: User name from config
2. Define User Value
- Problem: What user problem does this flow solve?
- Solution: How does this design solve it?
- Success criteria: How do we know it worked? (measurable outcomes)
3. List Design Artifacts
- List all scenarios included (reference
C-UX-Scenarios/files) - List user flows covered
- List design system components used (reference
D-Design-System/if applicable)
4. Define Technical Requirements
- Specify platform and tech stack constraints
- List integrations needed (APIs, third-party services)
- Define data models (what data is created, read, updated, deleted)
- Set performance requirements (load times, responsiveness)
5. Define Acceptance Criteria
- List functional requirements (what must work)
- List non-functional requirements (how it must perform)
- Define edge cases to handle (empty states, errors, boundaries)
6. Add Testing Guidance
- Define user testing approach (what to observe, who to test with)
- Define QA testing scope (browsers, devices, screen sizes)
- Define design validation checks (does implementation match spec?)
7. Estimate Complexity
- Estimate size and effort (T-shirt sizing or hours)
- Identify dependencies (other deliveries, external services)
- Document assumptions (what we're taking for granted)
- Assess risk level (low / medium / high) with rationale
8. Validate Delivery File
Before proceeding, verify:
- Delivery ID is unique and follows format
- All required fields are filled
- All scenarios are referenced
- All components are listed
- Technical requirements are clear
- Acceptance criteria are testable
- Complexity estimate is realistic
Design Delivery file created: deliveries/DD-XXX-name.yaml
9. Present MENU OPTIONS
Display: "Select an Option: [C] Continue to Create Test Scenario | [M] Return to Activity Menu"
Menu Handling Logic:
- IF C: Load, read entire file, then execute {nextStepFile}
- IF M: Return to {workflowFile} or {activityWorkflowFile}
- IF Any other comments or queries: help user respond then Redisplay Menu Options
EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- User can chat or ask questions — always respond and then redisplay menu options
CRITICAL STEP COMPLETION NOTE
ONLY WHEN the user selects an option from the menu and the Design Delivery file has been created and validated will you proceed to the next step or return as directed.
🚨 SYSTEM SUCCESS/FAILURE METRICS
✅ SUCCESS:
- Delivery ID assigned and unique
- All required sections completed with user input
- User value clearly defined (problem, solution, success criteria)
- All design artifacts referenced
- Technical requirements specified
- Acceptance criteria are testable
- Complexity estimated with risk assessment
- Delivery file saved
❌ SYSTEM FAILURE:
- Skipping any required delivery section
- Saving incomplete delivery file
- Not referencing actual scenario specifications
- Generating content without user input
- Not validating delivery file before proceeding
Master Rule: Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.