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
| Agent |
Specialization |
Use When |
ring:functional-writer |
Conceptual docs, guides, tutorials, best practices, workflows |
Writing product guides, tutorials, "how to" content |
ring:api-writer |
REST API reference, endpoints, schemas, errors, field descriptions |
Documenting API endpoints, request/response examples |
ring:docs-reviewer |
Voice/tone, structure, completeness, clarity, accuracy |
Reviewing drafts, pre-publication quality check |
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
- Lead with clear definition paragraph
- Use bullet points for key characteristics
- Separate sections with
--- dividers
- Include info boxes and warnings where needed
- Link to related API reference
- 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
| Plugin |
Use For |
| ring:using-ring (default) |
ORCHESTRATOR principle |
| ring:using-dev-team |
Developer agents for technical accuracy |
| ring:using-pm-team |
Pre-dev planning before documentation |
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."
1---2name: ring-using-tw-team3description: Technical writing specialists for functional and API documentation. Dispatch when you need to create guides, conceptual docs, or API references following established documentation standards.4---5
6# Using Ring Technical Writing Specialists
7
8The ring-tw-team plugin provides specialized agents for technical documentation. Use them via `Task tool with subagent_type:`.
9
10**Remember:** Follow the **ORCHESTRATOR principle** from `ring:using-ring`. Dispatch agents to handle documentation tasks; don't write complex documentation directly.
11
12## 3 Documentation Specialists
13
14| Agent | Specialization | Use When |
15|-------|---------------|----------|
16| `ring:functional-writer` | Conceptual docs, guides, tutorials, best practices, workflows | Writing product guides, tutorials, "how to" content |
17| `ring:api-writer` | REST API reference, endpoints, schemas, errors, field descriptions | Documenting API endpoints, request/response examples |
18| `ring:docs-reviewer` | Voice/tone, structure, completeness, clarity, accuracy | Reviewing drafts, pre-publication quality check |
19
20---
21
22## Documentation Standards Summary
23
24### Voice and Tone
25- **Assertive, but never arrogant** – Say what needs to be said, clearly
26- **Encouraging and empowering** – Guide users through complexity
27- **Tech-savvy, but human** – Use technical terms when needed, prioritize clarity
28- **Humble and open** – Confident but always learning
29
30### Capitalization
31- **Sentence case** for all headings and titles
32- Only first letter and proper nouns capitalized
33- ✅ "Getting started with the API"
34- ❌ "Getting Started With The API"
35
36### Structure Patterns
371. Lead with clear definition paragraph
382. Use bullet points for key characteristics
393. Separate sections with `---` dividers
404. Include info boxes and warnings where needed
415. Link to related API reference
426. Add code examples for technical topics
43
44---
45
46## Dispatching Specialists
47
48**Parallel dispatch** for comprehensive documentation (single message, multiple Tasks):
49
50```
51Task #1: functional-writer (write the guide)
52Task #2: api-writer (write API reference)
53(Both run in parallel)
54
55Then:
56Task #3: docs-reviewer (review both)
57```
58
59---
60
61## Available in This Plugin
62
63**Agents:** functional-writer, api-writer, docs-reviewer
64
65**Skills:**
66- using-tw-team: Plugin introduction
67- writing-functional-docs: Functional doc patterns
68- writing-api-docs: API reference patterns
69- documentation-structure: Hierarchy and organization
70- voice-and-tone: Voice guidelines
71- documentation-review: Quality checklist
72- api-field-descriptions: Field description patterns
73
74**Commands:**
75- /write-guide: Start functional guide
76- /write-api: Start API documentation
77- /review-docs: Review existing docs
78
79---
80
81## Integration with Other Plugins
82
83| Plugin | Use For |
84|--------|---------|
85| ring:using-ring (default) | ORCHESTRATOR principle |
86| ring:using-dev-team | Developer agents for technical accuracy |
87| ring:using-pm-team | Pre-dev planning before documentation |
88
89---
90
91## ORCHESTRATOR Principle
92
93- **You're the orchestrator** – Dispatch specialists, don't write directly
94- **Let specialists apply standards** – They know voice, tone, structure
95- **Combine with other plugins** – API writers + backend engineers for accuracy
96
97> ✅ "I need documentation for the new feature. Let me dispatch functional-writer."
98>
99> ❌ "I'll manually write all the documentation myself."
majiayu000