Using Ring Technical Writing Specialists

The ring-tw-team plugin provides specialized agents for technical documentation. Use them via Task tool with subagent_type:.

Remember: Follow the ORCHESTRATOR principle from ring:using-ring. Dispatch agents to handle documentation tasks; don't write complex documentation directly.

3 Documentation Specialists

Documentation Standards Summary

Voice and Tone

• Assertive, but never arrogant – Say what needs to be said, clearly
• Encouraging and empowering – Guide users through complexity
• Tech-savvy, but human – Use technical terms when needed, prioritize clarity
• Humble and open – Confident but always learning

Capitalization

• Sentence case for all headings and titles
• Only first letter and proper nouns capitalized
• ✅ "Getting started with the API"
• ❌ "Getting Started With The API"

Structure Patterns

1. Lead with clear definition paragraph
2. Use bullet points for key characteristics
3. Separate sections with --- dividers
4. Include info boxes and warnings where needed
5. Link to related API reference
6. Add code examples for technical topics

Dispatching Specialists

Parallel dispatch for comprehensive documentation (single message, multiple Tasks):

Task #1: functional-writer (write the guide)
Task #2: api-writer (write API reference)
(Both run in parallel)

Then:
Task #3: docs-reviewer (review both)

Available in This Plugin

Agents: functional-writer, api-writer, docs-reviewer

Skills:

• using-tw-team: Plugin introduction
• writing-functional-docs: Functional doc patterns
• writing-api-docs: API reference patterns
• documentation-structure: Hierarchy and organization
• voice-and-tone: Voice guidelines
• documentation-review: Quality checklist
• api-field-descriptions: Field description patterns

Commands:

• /write-guide: Start functional guide
• /write-api: Start API documentation
• /review-docs: Review existing docs

Integration with Other Plugins

ORCHESTRATOR Principle

• You're the orchestrator – Dispatch specialists, don't write directly
• Let specialists apply standards – They know voice, tone, structure
• Combine with other plugins – API writers + backend engineers for accuracy

✅ "I need documentation for the new feature. Let me dispatch functional-writer."

❌ "I'll manually write all the documentation myself."