using-tw-team
Technical writing specialists for functional and API documentation. Dispatch when you need to create guides, conceptual docs, or API references following established documentation standards.
$ Installieren
git clone https://github.com/LerianStudio/ring /tmp/ring && cp -r /tmp/ring/tw-team/skills/using-tw-team ~/.claude/skills/ring// tip: Run this command in your terminal to install the skill
name: using-tw-team description: | Technical writing specialists for functional and API documentation. Dispatch when you need to create guides, conceptual docs, or API references following established documentation standards.
trigger: |
- Need to write functional documentation (guides, conceptual docs, tutorials)
- Need to write API reference documentation
- Need to review existing documentation quality
- Writing or updating product documentation
skip_when: |
- Writing code â use dev-team agents
- Writing plans â use pm-team agents
- General code review â use default plugin reviewers
related: similar: [using-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 using-ring. Dispatch agents to handle documentation tasks; don't write complex documentation directly.
3 Documentation Specialists
| Agent | Specialization | Use When |
|---|---|---|
functional-writer | Conceptual docs, guides, tutorials, best practices, workflows | Writing product guides, tutorials, "how to" content |
api-writer | REST API reference, endpoints, schemas, errors, field descriptions | Documenting API endpoints, request/response examples |
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 |
|---|---|
| using-ring (default) | ORCHESTRATOR principle |
| using-dev-team | Developer agents for technical accuracy |
| 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."
Repository
