OpenWriterControle/.opencode/context/content-creation/formats/written-content.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

409 lines
7.7 KiB
Markdown

<!-- Context: content-creation/written-content | Priority: low | Version: 1.0 | Updated: 2026-02-15 -->
# Written Content Guidelines
Best practices for creating effective written content across formats: articles, blog posts, social media, newsletters, and long-form content.
---
## Article Structure
### Standard Article Flow
**1. Hook (First 50 words)**
- Grab attention immediately
- Promise clear value
- Create curiosity
**2. Problem/Context (100-200 words)**
- Establish the problem or topic
- Show why it matters
- Build relevance
**3. Main Content (Body)**
- Deliver on the promise
- Use clear structure (subheadings, lists)
- Include examples and data
**4. Conclusion (50-100 words)**
- Summarize key points
- Reinforce main takeaway
- Clear call-to-action
---
## Blog Post Best Practices
### Formatting for Readability
**Short paragraphs**:
- 1-3 sentences max
- White space improves scanning
- Mobile-friendly
**Subheadings every 200-300 words**:
- Break up long sections
- Enable skimming
- Improve SEO
**Bullet points and lists**:
- Easy to scan
- Highlight key points
- Increase engagement
**Bold key phrases**:
- Draw attention to important points
- Help skimmers find value
- Don't overuse (2-3 per section max)
---
### Blog Post Length Guidelines
**Short-form (300-600 words)**:
- Quick tips
- News and updates
- Opinion pieces
- Social media-friendly
**Medium-form (800-1500 words)**:
- How-to guides
- List posts
- Case studies
- Most versatile length
**Long-form (2000+ words)**:
- Comprehensive guides
- In-depth tutorials
- Research-backed content
- SEO pillar content
---
### Blog Post Templates
**How-To Post**:
1. Hook with the problem
2. Why this solution works
3. Step-by-step instructions
4. Common mistakes to avoid
5. Next steps
**List Post**:
1. Hook with promise (X ways to Y)
2. Brief intro
3. Each item with explanation
4. Summary of key points
5. Call-to-action
**Case Study**:
1. Hook with result
2. Starting situation
3. Challenge/problem
4. Solution/process
5. Results and lessons
6. How to apply it
---
## Social Media Posts
### Platform-Specific Guidelines
**Twitter/X**:
- Hook in first line
- Use line breaks for readability
- Thread for longer content
- End with engagement question or CTA
**LinkedIn**:
- Professional but personal tone
- Story-driven content performs well
- Use "see more" strategically
- Include relevant hashtags (3-5)
**Instagram**:
- Visual-first, caption supports
- Hook before "more" cutoff
- Use emojis strategically
- Hashtags in comments or end of caption
**Facebook**:
- Conversational tone
- Questions drive engagement
- Native video outperforms links
- Community-focused content
---
### Social Post Structure
**Pattern 1: Hook + Story + Lesson**
```
[Attention-grabbing first line]
[Short story or example]
[Key lesson or takeaway]
[Call-to-action or question]
```
**Pattern 2: Problem + Agitation + Solution**
```
[Identify relatable problem]
[Make it worse / show impact]
[Offer solution or insight]
[Next step]
```
**Pattern 3: List Format**
```
[Hook: X things about Y]
1. [Point with brief explanation]
2. [Point with brief explanation]
3. [Point with brief explanation]
[Closing thought or CTA]
```
---
## Newsletter Structure
### Email Newsletter Best Practices
**Subject Line**:
- 40-50 characters ideal
- Create curiosity or promise value
- Personalization when relevant
- A/B test regularly
**Preview Text**:
- First 50-100 characters matter
- Extend the subject line hook
- Don't waste with "View in browser"
**Opening**:
- Personal greeting
- Quick context or story
- Promise what's in this email
**Body**:
- One main idea per email (or clear sections)
- Scannable format
- Links to full content if needed
- Visual breaks (images, dividers)
**Closing**:
- Clear call-to-action
- Personal sign-off
- P.S. for secondary CTA or bonus
---
### Newsletter Types
**Curated Newsletter**:
- Intro with theme
- 3-7 curated items
- Brief commentary on each
- Why it matters
**Story Newsletter**:
- Personal story or case study
- Lesson or insight
- How to apply it
- Single clear CTA
**Educational Newsletter**:
- One main teaching point
- Step-by-step or framework
- Examples
- Action item
---
## Long-Form Content
### Long-Form Structure
**Comprehensive Guide Structure**:
1. Table of contents
2. Introduction (why this matters)
3. Main sections (3-7 major topics)
4. Examples and case studies
5. Common mistakes/FAQs
6. Conclusion and next steps
7. Resources and further reading
---
### Long-Form Best Practices
**Navigation**:
- Table of contents with jump links
- Progress indicators
- "Back to top" links
- Clear section breaks
**Engagement**:
- Vary content types (text, images, examples)
- Include interactive elements
- Break up with quotes or callouts
- Summarize key points in boxes
**Retention**:
- Deliver value early and often
- Use open loops (promise info later)
- Include surprising insights
- Make it skimmable
---
## SEO Considerations
### On-Page SEO Basics
**Title Tag**:
- Include target keyword
- 50-60 characters
- Compelling and clickable
**Meta Description**:
- 150-160 characters
- Include keyword naturally
- Promise clear value
**Headings**:
- H1 for main title (one per page)
- H2 for main sections
- H3 for subsections
- Include keywords naturally
**Internal Links**:
- Link to related content
- Use descriptive anchor text
- Help readers find more value
**Images**:
- Descriptive file names
- Alt text for accessibility and SEO
- Compressed for speed
---
### Keyword Integration
**Natural placement**:
- Title and first paragraph
- Subheadings where relevant
- Throughout body naturally
- Don't force or over-optimize
**Semantic keywords**:
- Related terms and phrases
- Answer related questions
- Cover topic comprehensively
---
## Readability Optimization
### Readability Checklist
- [ ] Grade level: 8th grade or below for general audience
- [ ] Sentence length: Average 15-20 words
- [ ] Paragraph length: 3 sentences or less
- [ ] Active voice: 80%+ of sentences
- [ ] Transition words: Connect ideas smoothly
- [ ] Jargon: Explained or avoided
- [ ] Examples: Concrete and relatable
---
### Readability Tools
**Hemingway Editor**:
- Highlights complex sentences
- Identifies passive voice
- Suggests simpler alternatives
**Grammarly**:
- Grammar and spelling
- Tone detection
- Clarity suggestions
**Yoast SEO** (WordPress):
- Readability analysis
- SEO optimization
- Content structure
---
## Content Quality Checklist
Before publishing, verify:
- [ ] Hook grabs attention in first 50 words
- [ ] Clear value proposition
- [ ] Scannable format (headings, lists, bold)
- [ ] Short paragraphs (1-3 sentences)
- [ ] Examples and specifics (not just theory)
- [ ] Clear call-to-action
- [ ] Proofread for errors
- [ ] Links work and are relevant
- [ ] Images optimized and have alt text
- [ ] Mobile-friendly formatting
---
## Common Written Content Mistakes
### ❌ Burying the Lead
Starting with background instead of value.
### ✅ Lead with Value
Put the most important information first.
---
### ❌ Walls of Text
Long paragraphs that are hard to read.
### ✅ White Space
Short paragraphs with visual breaks.
---
### ❌ Vague Promises
"This will help you improve your content."
### ✅ Specific Value
"Learn the 3-second hook formula that increased my engagement 300%."
---
### ❌ No Clear CTA
Ending without telling readers what to do next.
### ✅ Clear Next Step
"Try this framework on your next post and let me know how it works."
---
## Usage
Apply these guidelines when creating:
- Blog posts and articles
- Social media content
- Email newsletters
- Landing page copy
- Long-form guides
- Any written content
**Remember**: Write for humans first, optimize for algorithms second. Clarity and value always win.