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,76 @@
|
||||
# Tone of Voice - Output Template
|
||||
|
||||
Use this template to document the final Tone of Voice in the Product Brief.
|
||||
|
||||
```markdown
|
||||
## Tone of Voice
|
||||
|
||||
**For UI Microcopy & System Messages**
|
||||
|
||||
### Tone Attributes
|
||||
|
||||
1. **[Attribute 1]**: [Brief description]
|
||||
2. **[Attribute 2]**: [Brief description]
|
||||
3. **[Attribute 3]**: [Brief description]
|
||||
|
||||
### Examples
|
||||
|
||||
**Error Messages:**
|
||||
- ✅ "Hmm, that doesn't look like an email. Check for typos?"
|
||||
- ❌ "Error: Invalid email format"
|
||||
|
||||
**Button Text:**
|
||||
- ✅ "Let's get started"
|
||||
- ❌ "Submit"
|
||||
|
||||
**Empty States:**
|
||||
- ✅ "Nothing here yet. Ready to add your first item?"
|
||||
- ❌ "No results found"
|
||||
|
||||
**Success Messages:**
|
||||
- ✅ "You're all set! We've sent a confirmation to your email."
|
||||
- ❌ "Operation completed successfully"
|
||||
|
||||
### Guidelines
|
||||
|
||||
**Do:**
|
||||
- [Tone-appropriate practice 1]
|
||||
- [Tone-appropriate practice 2]
|
||||
- [Tone-appropriate practice 3]
|
||||
|
||||
**Don't:**
|
||||
- [Tone-inappropriate practice 1]
|
||||
- [Tone-inappropriate practice 2]
|
||||
|
||||
---
|
||||
|
||||
*Note: Tone of Voice applies to UI microcopy. Strategic content (headlines, feature descriptions, value propositions) uses the Content Creation Workshop based on page-specific purpose and context.*
|
||||
```
|
||||
|
||||
## Example Microcopy Format
|
||||
|
||||
When presenting examples, use this comparison format:
|
||||
|
||||
```
|
||||
Example UI Microcopy:
|
||||
|
||||
Error Message:
|
||||
❌ Generic: "Error: Invalid input"
|
||||
✅ Our Tone: [Rewritten in proposed tone]
|
||||
|
||||
Button Text:
|
||||
❌ Generic: "Submit"
|
||||
✅ Our Tone: [Rewritten in proposed tone]
|
||||
|
||||
Empty State:
|
||||
❌ Generic: "No results found"
|
||||
✅ Our Tone: [Rewritten in proposed tone]
|
||||
|
||||
Form Label:
|
||||
❌ Generic: "Email address"
|
||||
✅ Our Tone: [Rewritten in proposed tone]
|
||||
|
||||
Success Message:
|
||||
❌ Generic: "Operation successful"
|
||||
✅ Our Tone: [Rewritten in proposed tone]
|
||||
```
|
||||
Reference in New Issue
Block a user