OpenWriterControle/.opencode/context/content-creation/principles/tone-voice.md
Darren Hinde 5a40b6fdc4
feat(context): Standardize context system with navigation, frontmatter, and MVI compliance (#209)
* feat: add OAC package refactor context file

- Add comprehensive feature context for OAC package refactor
- Document multi-IDE support architecture
- Define community component registry (shadcn-like)
- Outline flexible configuration system
- Detail context file location flexibility
- Define 7-phase implementation plan
- Include CLI commands reference
- Add community publishing guidelines

* docs: add OAC refactor quick start guide

- Add quick reference for Phase 1 implementation
- Include project structure and file locations
- Document configuration schema and defaults
- Add testing strategy and validation steps
- Include development workflow
- Reference all related resources

* feat: add critical user approval and context resolution systems

CRITICAL FEATURES ADDED:

1. User Approval & YOLO Mode
   - Default: Interactive approval for all file operations
   - Always asks: local vs global install
   - Confirms before overwriting files
   - Shows diffs and file details
   - YOLO mode (--yolo): Skip confirmations, auto-resolve, report at end
   - Conflict strategies: ask, skip, overwrite, backup, yolo
   - Safety: backups, git detection, rollback support, audit log

2. Context Resolution System
   - Layered context resolution (6 priority levels)
   - Project override (.oac/context/) - highest priority
   - Project context (.opencode/context/)
   - IDE context (.cursor/, .claude/)
   - Project docs (docs/)
   - User global (~/.config/oac/context/)
   - OAC official (~/.config/oac/official/) - lowest priority
   - Smart resolution based on agent location (global vs local)
   - preferLocal config option
   - Context merging strategies
   - CLI commands for context management
   - Environment variable overrides
   - Validation and fallback support

3. Enhanced CLI Commands
   - All commands support --yolo, --dry-run, --local, --global
   - Context management: resolve, list, validate, override, sync
   - Detailed help and examples
   - Global flags for all commands

This ensures users maintain full control over their projects while
supporting both local and global workflows with intelligent context
resolution.

* feat: add component creation wizard and IDE feature parity system

NEW FEATURES:

1. Interactive Component Creation
   - oac create (interactive wizard)
   - Create agents, skills, contexts, plugins, commands, tools
   - Template system for scaffolding
   - Auto-generate tests and boilerplate
   - Multi-IDE compatibility selection
   - Size optimization options

2. IDE Feature Parity & Capacity Management (CRITICAL)
   - Feature support matrix for all IDEs
   - OpenCode/Claude Code: Full support (all features)
   - Cursor: Limited (single file, no skills/plugins, 100KB limit)
   - Windsurf: Partial support
   - Adaptive installation based on IDE capabilities
   - Automatic feature filtering and warnings
   - Component merging for single-file IDEs (Cursor)
   - Capacity warnings and optimization
   - IDE-specific profiles

3. Enhanced CLI Commands
   - oac create [type] - Component creation wizard
   - oac templates - List available templates
   - oac compatibility <ide> - Check IDE compatibility
   - oac ides - List supported IDEs with features
   - oac ide info <ide> - Show IDE capabilities
   - oac optimize --for <ide> - Optimize for specific IDE
   - oac validate --ide <ide> - Validate IDE installation

4. Smart Installation
   - Detects IDE capabilities
   - Warns about unsupported features
   - Auto-filters components
   - Merges agents for Cursor
   - Embeds contexts for limited IDEs
   - Monitors file size limits
   - Suggests IDE-specific profiles

This ensures users can easily create components and OAC gracefully
handles different IDE capabilities with clear warnings and automatic
optimization.

* docs: add critical feedback from parallel agent review

CRITICAL FINDINGS:

Security Gaps (BLOCKER):
- No component signing or verification
- No malware/secret scanning
- No permission system
- Action: Add security layer in Phase 1

Missing Features (CRITICAL):
- Discovery (browse, search, trending)
- Lockfile for reproducibility
- Version conflict management
- Interactive onboarding
- Progress indicators
- Auto-detection for local/global

Approaches to Rethink:
- Context merging → Use composition instead
- Always asking local/global → Auto-detect with smart defaults
- Cursor agent merging → Router pattern instead

Repository Structure:
- Recommended: Monorepo with pnpm workspaces
- Packages: core, adapters, registry, security, cli
- Benefits: Shared deps, atomic commits, easier testing

Community Workflow:
- Component submission process
- Automated security scanning
- Manual review for verification
- Moderation system

Updated Priorities:
- v1.0 MVP: Add 6 critical features (discovery, lockfile, security, etc.)
- v1.1: Plugin system, workspace support, marketplace
- v2.0: Enterprise features

Documentation Needs:
- Quick Start (5-minute guide)
- CLI Reference (auto-generated)
- Recipes/Cookbook
- Component Creation Guide
- Migration Guide

Overall: Plan is 80% solid, needs 20% critical additions before Phase 1

* feat: add comprehensive agent customization and preset system

CRITICAL FEATURE: Agent Customization & Personal Presets

Problem:
- Users want to customize agent prompts for their workflow
- Users want to save personal configurations
- Updates shouldn't overwrite customizations
- Need easy way to view and edit agents

Solution: Multi-Layer Customization System

Layer 1: View Agent Configuration
- oac show agent:openagent (view in pager)
- oac edit agent:openagent (open in editor)
- oac config show agent:openagent (config only)
- oac export agent:openagent (export to file)

Layer 2: Create Personal Preset
- oac customize agent:openagent (create preset)
- Copies to ~/.config/oac/presets/agents/
- Links to base agent for updates
- Tracks customizations in metadata

Layer 3: Edit Personal Preset
- oac edit preset:my-openagent (edit in $EDITOR)
- oac customize preset:my-openagent --interactive (wizard)
- Auto-backup on save
- Track modification history

Layer 4: Use Personal Preset
- oac use preset:my-openagent (activate)
- oac use preset:my-openagent --global (set default)
- oac presets list --active (show active)
- Switch between presets and base agents

Layer 5: Update Management (CRITICAL)
- Smart update detection for base agents
- Merge strategies: manual, auto-base, auto-merge, locked
- Conflict resolution with user prompts
- Show diffs before merging
- Auto-backup before updates
- Preserve user customizations by default

Layer 6: Preset Sharing
- oac export preset:my-openagent (export)
- oac import preset ./preset.md (import)
- oac share preset:my-openagent (share with team)
- oac publish preset:my-openagent (publish to community)

Layer 7: In-Place Editing (Advanced)
- oac edit agent:openagent --in-place (risky, warns user)
- Creates backup before editing
- Warns that updates will overwrite
- Recommends preset creation instead

Update Strategies:
- manual: User reviews every update
- auto-base: Auto-update base, keep preset unchanged
- auto-merge: Auto-merge, prompt on conflicts
- locked: Never update base

Configuration:
- Preset metadata (.presets.json)
- Update strategies per preset
- Merge conflict resolution
- Backup management
- Warning preferences

Edge Cases Handled:
- In-place edits before updates
- Multiple updates behind
- Multiple presets for same base
- Preset conflicts with IDE
- Deleted base agent

Best Practices:
- Always create presets (safest)
- Document customizations
- Review updates before merging
- Keep backups
- Use descriptive names

This ensures users can safely customize agents without fear of
losing changes on updates, while still benefiting from base agent
improvements.

* docs: complete comprehensive user scenario analysis (16,014 lines)

PLANNING PHASE COMPLETE:

Documents Created (9 files, 400KB):
- 00-INDEX.md (388 lines) - Planning index and overview
- 01-main-plan.md (2,338 lines) - Complete feature specification
- 02-quickstart-guide.md (450 lines) - Phase 1 quick reference
- 03-critical-feedback.md (599 lines) - Parallel agent review
- 04-solo-developer-scenarios.md (2,106 lines) - Individual workflows
- 05-team-lead-scenarios.md (3,977 lines) - Team collaboration
- 07-content-creator-scenarios.md (2,581 lines) - Non-technical users
- 08-open-source-maintainer-scenarios.md (3,575 lines) - Community management
- 09-SYNTHESIS.md (1,000+ lines) - Consolidated findings

User Personas Analyzed (4/5):
✅ Solo Developer (Primary - 40% market)
✅ Team Lead (Secondary - 30% market)
✅ Content Creator (Emerging - 20% market)
✅ Open Source Maintainer (Future - 5% market)
⏸️ Enterprise Admin (Deferred to v2.0 - 5% market)

Key Findings:

Solo Developer (Primary User):
- Setup must be < 2 minutes or they skip
- Preview before committing (try mode)
- Safe customization (presets)
- Easy rollback/undo
- Zero docs reading to start

Team Lead (Secondary User):
- Lockfile is non-negotiable (oac.lock)
- Team configuration (oac-team.json)
- Compliance monitoring (90%+ required)
- Onboarding: 4-8 hours → 15 minutes (96% reduction)
- Staged rollouts for updates

Content Creator (Emerging - 20% market):
- CLI is intimidating (need GUI wrapper)
- Plain language mode (no jargon)
- Visual undo (version history)
- Templates and examples
- Guided setup

Open Source Maintainer (Future):
- Security scanning pipeline (ClamAV + gitleaks)
- Quality gates (70% test coverage)
- Review/approval workflow
- Deprecation workflow
- Sustainability model

Critical Additions to MVP:
1. Interactive onboarding wizard (all personas)
2. TUI browser with preview (solo dev, team lead)
3. Lockfile (oac.lock) (team lead)
4. Security scanning (all personas)
5. Try mode (solo dev)
6. Team configuration (team lead)
7. oac doctor health checks (solo dev)
8. Quality gates (maintainer)

Market Opportunity:
- v1.0: 70% market (solo + team)
- v1.1: 90% market (+ content creators with GUI)
- v2.0: 100% market (+ enterprise)

Recommended Changes:
- Expand MVP scope (+2 weeks, 9 weeks total)
- Plan v1.1 for content creators (GUI wrapper)
- Defer enterprise features to v2.0
- Build community features early (trust)

Status: Ready to finalize plan and start implementation
Confidence: Very High (95%+)
Risk: Low (comprehensive analysis complete)

* docs: add comprehensive final review of OAC planning

FINAL REVIEW COMPLETE:

Overall Assessment: CONDITIONAL GO ✅⚠️
Confidence Level: 85% (High, with conditions)
Success Probability: 75% (with modifications)

Key Strengths:
✅ Exceptional user research (16,000+ lines, 4 personas)
✅ Clear technical architecture (monorepo, TypeScript, Zod)
✅ Security-first mindset (signing, scanning, verification)
✅ Realistic scope management (v1.0 vs v1.1 vs v2.0)
✅ Comprehensive feature coverage

Critical Gaps Identified:
❌ Discovery/Onboarding not in Phase 1 (but P0 in scenarios)
❌ Lockfile not in Phase 2 (but critical for teams)
❌ Security Pipeline not detailed in phases
❌ Progress UI not in Phase 1 (but needed for UX)
❌ Auto-detection not in Phase 1 (but reduces friction)

Conditions for Go:
1. Add discovery/onboarding to Phase 1 (+3 days)
2. Add lockfile to Phase 2 (+2 days)
3. Add security pipeline to Phase 1 (+2 days)
4. Add progress UI to Phase 1 (+1 day)
5. Revise timeline: 7 weeks → 9 weeks

Critical Action Items (6 days before Phase 1):
1. Add missing features to phases (2 days)
2. Define acceptance criteria (1 day)
3. Define testing strategy (1 day)
4. Design security pipeline (1 day)
5. Create monorepo structure (1 day)

Top Risks:
🔴 Timeline Slip (70% probability, high impact)
🟡 Scope Creep (50% probability, high impact)
🟡 Context Merging Complexity (60% probability, medium impact)

Recommendation: PROCEED WITH MODIFICATIONS
- Complete 6 days of prerequisite work
- Extend timeline to 9 weeks
- Add missing features to phases
- Define acceptance criteria and testing strategy

Status: READY TO IMPLEMENT (with modifications)
Next Steps: Complete prerequisites → Setup monorepo → Start Phase 1

* feat(context): Standardize context system with navigation, frontmatter, and MVI compliance

- Add 77 navigation.md files across all context categories for token-efficient discovery
- Standardize frontmatter format on 198+ context files (HTML comment format, 2026-02-15)
- Compress 3 oversized guide files applying MVI principle (802 lines removed, 63% reduction)
- Add context system analysis and planning artifacts in context-findings/
- Add task management enhancements (stage orchestration, planning subagents)
- Document compression techniques and future optimization recommendations

Context System Improvements:
- All active directories now have navigation.md (200-300 tokens each)
- 100% frontmatter compliance with priority/version/date metadata
- Improved scannability through MVI compression (compact.md, organizing-context.md, creation.md)
- Token efficiency increased for AI agent consumption

Planning & Analysis:
- Context system implementation plan and simplification analysis
- ADR standard proposal and runtime permission architecture
- SQLite context design for future scale (deferred until 500+ files)
- Context discovery script analysis (rejected in favor of navigation-first)

Task Management:
- Enhanced task schema with stage orchestration support
- New planning subagents (ADR, Architecture, Story Mapping, Prioritization)
- Stage orchestrator for multi-stage workflow management
- Session context management and lightweight handoff patterns

Closes: context-simple-fixes task
Ref: context-system-implementation analysis

* fix: resolve markdown link validation errors in navigation files

- Remove non-existent react-patterns.md link from react/navigation.md
- Remove non-existent premium-dark-ui-quick-start.md link from design/navigation.md
- Add skip patterns for pre-existing broken links in example/template files
- Validation now passes: 215 files validated, 0 errors

* fix: resolve all 119 broken markdown links across documentation

- Update agent paths to new subagents structure (TestEngineer, ContextScout, etc.)
- Fix animation file references (animation-ui.md → animation-components.md)
- Update guide references (adding-agent.md → adding-agent-basics.md)
- Convert non-existent example paths to placeholder text format
- Add skip patterns for intentional example placeholders
- Validation now passes: 232 files validated, 0 errors

Co-authored-by: CoderAgent <coder@openagents.dev>

---------

Co-authored-by: CoderAgent <coder@openagents.dev>
2026-02-15 23:01:19 +00:00

348 lines
7.4 KiB
Markdown

<!-- Context: content-creation/tone-voice | Priority: low | Version: 1.0 | Updated: 2026-02-15 -->
# Tone & Voice Guidelines
**Category**: content
**Purpose**: Maintaining consistent brand voice and adapting tone for different contexts
**Used by**: copywriter, technical-writer
---
## Overview
Voice is your brand's personality - it stays consistent. Tone is how that voice adapts to different situations and audiences. This guide helps maintain consistency while being contextually appropriate.
## Voice vs. Tone
### Voice (Consistent)
Your brand's personality that never changes:
- Professional but approachable
- Knowledgeable but not condescending
- Confident but humble
- Clear and direct
### Tone (Adaptive)
How voice adapts to context:
- **Error messages**: Apologetic, helpful
- **Success messages**: Encouraging, celebratory
- **Marketing**: Enthusiastic, persuasive
- **Documentation**: Clear, instructional
- **Support**: Empathetic, solution-focused
## Voice Dimensions
### 1. Formality Spectrum
**Formal** ←→ **Casual**
**Formal**:
```
"We appreciate your business and look forward to serving you."
```
**Casual**:
```
"Thanks for choosing us! We're excited to work with you."
```
**Choose based on**:
- Industry norms
- Audience expectations
- Context (legal vs. social)
### 2. Enthusiasm Spectrum
**Reserved** ←→ **Enthusiastic**
**Reserved**:
```
"Your account has been created successfully."
```
**Enthusiastic**:
```
"Welcome aboard! Your account is ready to go! 🎉"
```
**Choose based on**:
- Moment significance
- User emotional state
- Brand personality
### 3. Expertise Spectrum
**Educational** ←→ **Expert**
**Educational**:
```
"Let's walk through this step by step. First, click the
'Settings' button in the top right corner."
```
**Expert**:
```
"Navigate to Settings > Advanced > API Configuration."
```
**Choose based on**:
- User expertise level
- Content complexity
- Context (onboarding vs. advanced docs)
## Tone Guidelines by Context
### 1. Marketing Copy
**Characteristics**:
- Enthusiastic and persuasive
- Benefit-focused
- Action-oriented
- Emotionally engaging
**Example**:
```
"Transform your workflow in minutes, not months. Join 10,000+
teams who've already made the switch."
```
### 2. Product Documentation
**Characteristics**:
- Clear and instructional
- Step-by-step
- Neutral tone
- Technically accurate
**Example**:
```
"To configure authentication:
1. Navigate to Settings > Security
2. Click 'Add Authentication Method'
3. Select your preferred provider"
```
### 3. Error Messages
**Characteristics**:
- Apologetic but not overly so
- Explain what happened
- Provide clear next steps
- Never blame the user
**Bad**:
```
"Error: Invalid input. Try again."
```
**Good**:
```
"We couldn't process your request because the email format
isn't valid. Please check and try again."
```
### 4. Success Messages
**Characteristics**:
- Positive and encouraging
- Confirm what happened
- Suggest next steps
- Celebrate wins
**Example**:
```
"Great! Your changes have been saved. Ready to publish?"
```
### 5. Support Communication
**Characteristics**:
- Empathetic and understanding
- Solution-focused
- Patient and helpful
- Personalized
**Example**:
```
"I understand how frustrating this must be. Let's get this
sorted out for you. Can you tell me what you see when you
click the 'Export' button?"
```
### 6. Onboarding
**Characteristics**:
- Welcoming and encouraging
- Educational without overwhelming
- Progressive disclosure
- Celebrate small wins
**Example**:
```
"Welcome! Let's get you set up in 3 quick steps.
First, let's create your workspace."
```
## Writing Principles
### 1. Be Clear and Concise
**Before**:
```
"In order to facilitate the process of account creation,
it is necessary for you to provide your email address."
```
**After**:
```
"Enter your email to create your account."
```
### 2. Use Active Voice
**Passive**:
```
"Your password has been reset by our system."
```
**Active**:
```
"We've reset your password."
```
### 3. Write for Humans
**Robotic**:
```
"Operation completed successfully. Proceed to next step."
```
**Human**:
```
"All set! What would you like to do next?"
```
### 4. Be Inclusive
**Exclusive**:
```
"Hey guys, check out our new feature!"
```
**Inclusive**:
```
"Check out our new feature!"
```
### 5. Avoid Jargon
**Jargon-heavy**:
```
"Leverage our API to synergize your tech stack."
```
**Clear**:
```
"Connect our API to your existing tools."
```
## Emotional Tone Mapping
### User Emotional State → Appropriate Tone
**User is frustrated** → Empathetic, solution-focused
```
"I know this is frustrating. Let's fix this together."
```
**User achieved something** → Celebratory, encouraging
```
"Awesome work! You've completed your first project."
```
**User is confused** → Patient, educational
```
"No worries! Let me break this down for you."
```
**User made an error** → Helpful, non-judgmental
```
"Looks like there's a small issue. Here's how to fix it."
```
**User is new** → Welcoming, supportive
```
"Welcome! We're here to help you get started."
```
## Brand Voice Examples
### Example 1: Tech Startup (Friendly, Modern)
```
Voice: Approachable, innovative, helpful
Tone variations:
- Marketing: "Build amazing things, faster"
- Error: "Oops! Something went wrong. Let's try that again."
- Success: "Nice! You're all set."
```
### Example 2: Enterprise SaaS (Professional, Trustworthy)
```
Voice: Professional, reliable, expert
Tone variations:
- Marketing: "Enterprise-grade security you can trust"
- Error: "We encountered an issue. Please contact support."
- Success: "Configuration saved successfully."
```
### Example 3: Creative Tool (Inspiring, Playful)
```
Voice: Creative, inspiring, fun
Tone variations:
- Marketing: "Unleash your creativity"
- Error: "Hmm, that didn't work. Let's try something else!"
- Success: "Beautiful! Your design is ready to share."
```
## Best Practices
1. **Create a voice chart** - Document your brand's voice attributes
2. **Use real examples** - Show, don't just tell
3. **Consider context** - Adapt tone to situation
4. **Be consistent** - Use the same voice across channels
5. **Avoid clichés** - "Think outside the box," "game-changer"
6. **Use contractions** - "We're" not "We are" (unless formal)
7. **Address the user** - Use "you" and "your"
8. **Be specific** - Concrete details over vague statements
9. **Test with users** - Does it resonate?
10. **Update regularly** - Voice evolves with your brand
## Anti-Patterns
- ❌ **Inconsistent voice** - Confuses users about your brand
- ❌ **Overly formal** - Creates distance from users
- ❌ **Too casual** - May seem unprofessional
- ❌ **Jargon overload** - Excludes non-experts
- ❌ **Passive voice** - Weakens your message
- ❌ **Blaming users** - "You entered the wrong password"
- ❌ **Fake enthusiasm** - "Amazing! Incredible! Awesome!" overuse
- ❌ **Corporate speak** - "Leverage synergies to optimize"
## Voice & Tone Checklist
Before publishing, verify:
- [ ] Does this sound like our brand?
- [ ] Is the tone appropriate for the context?
- [ ] Is it clear and easy to understand?
- [ ] Does it use active voice?
- [ ] Is it free of jargon?
- [ ] Does it address the user directly?
- [ ] Is it inclusive and respectful?
- [ ] Does it match our voice chart?
- [ ] Would I say this to someone in person?
- [ ] Does it help the user accomplish their goal?
## References
- Nicely Said by Nicole Fenton & Kate Kiefer Lee
- The Voice and Tone Guide by MailChimp
- Conversational Design by Erika Hall