- 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.0 KiB
5.0 KiB
name, description, nextStepFile, workflowFile, activityWorkflowFile
| name | description | nextStepFile | workflowFile | activityWorkflowFile |
|---|---|---|---|---|
| step-09-design-system-consistency | Verify components are used correctly and consistently across all page specifications | ./step-10-final-validation.md | ../workflow.md | ../workflow-validate.md |
Step 9: Validate Design System Consistency
STEP GOAL:
Verify components are used correctly and consistently across all page specifications.
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 cross-page component consistency and design system alignment
- 🚫 FORBIDDEN to skip shared component validation (header, footer, nav)
- 💬 Approach: Audit component usage across all pages, check naming and state consistency
- 📋 Design system is the single source of truth for component definitions
EXECUTION PROTOCOLS:
- 🎯 Audit component usage, naming, and consistency across all page specifications
- 💾 Update specifications if consistency fixes are approved by user
- 📖 Reference design system registry for component definitions
- 🚫 FORBIDDEN to skip design system completeness check
CONTEXT BOUNDARIES:
- Available context: All page specifications, design system components
- Focus: Cross-page component consistency only
- Limits: Do not validate individual page structure (covered by earlier steps)
- Dependencies: Design system must exist with component definitions
Sequence of Instructions (Do not deviate, skip, or optimize)
1. Component Usage
- All components reference design system definitions
- No inline component definitions that should be in design system
- Component variants used appropriately (not mixing similar components)
2. Naming Consistency
- Component names match design system registry
- No duplicate component names with different definitions
- Naming follows established conventions
3. Cross-Page Consistency
- Shared components (header, footer, nav) identical across pages
- Similar patterns use the same components (not ad-hoc alternatives)
- State definitions consistent for same components across pages
4. Design System Completeness
- All referenced components exist in design system
- No orphaned components (defined but never used)
- Component documentation sufficient for implementation
5. Generate Design System Consistency Report
## Design System Consistency Report
**Components in system:** [N]
**Components referenced:** [N]
**Consistency issues:** [N]
**Missing from system:** [N]
[List any inconsistencies or gaps]
6. Resolve Issues
If issues found, present to user and ask if they want you to fix the consistency issues.
7. Present MENU OPTIONS
Display: "Select an Option: [C] Continue to Final Validation | [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 system consistency validation is complete will you proceed to the next step or return as directed.
🚨 SYSTEM SUCCESS/FAILURE METRICS
✅ SUCCESS:
- Component usage audited across all page specifications
- Naming consistency verified against design system registry
- Shared components validated for cross-page consistency
- Design system completeness checked (no orphaned or missing components)
- Design System Consistency Report generated
- Issues resolved with user approval
❌ SYSTEM FAILURE:
- Not checking all page specifications
- Skipping shared component validation
- Not verifying naming against design system registry
- Not checking design system completeness
- Auto-fixing consistency issues without user approval
Master Rule: Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.