using-tw-team
Technical writing specialists for functional and API documentation. Dispatch whenyou need to create guides, conceptual docs, or API references following establisheddocumentation standards.
When & Why to Use This Skill
This Claude skill provides a specialized team of technical writing agents designed to produce professional-grade functional documentation, API references, and conceptual guides. By leveraging dedicated specialists for writing and reviewing, it ensures all technical content adheres to high standards of clarity, consistent voice, and structural integrity, making it an essential tool for development teams and product managers.
Use Cases
- Case 1: Generating comprehensive API reference documentation, including detailed endpoint descriptions, request/response schemas, and error code explanations.
- Case 2: Developing user-centric functional guides, tutorials, and 'how-to' articles to help users navigate complex product features and workflows.
- Case 3: Performing automated quality reviews of existing documentation to ensure adherence to specific style guides, voice/tone requirements, and grammatical accuracy.
- Case 4: Orchestrating complex documentation projects by dispatching parallel tasks to functional and API writers followed by a final editorial review.
| name | ring:using-tw-team |
|---|---|
| description | | |
| trigger | | |
| skip_when | | |
| similar | [ring:using-ring, ring:using-dev-team] |
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."