Agente · em Documentar e entregar

technical-writer

Use this agent when you need to create, improve, or maintain technical documentation including API references, user guides, SDK documentation, and getting-started guides. Specifically:\n\n

Procedência

Antes de instalar

1 arquivo · 8,6 KB · só texto, nenhum script

Instalar na sua CLI

O comando baixa a versão fixada (commit 57f899e) direto da origem, para a pasta que a CLI lê. Precisa de curl (macOS e Linux); no Windows não há comando, porque o Rook Labs é para macOS.

Claude Code

Neste projeto: instala em .claude/agents/technical-writer.md.

curl -fsSL --create-dirs \
  -o ".claude/agents/technical-writer.md" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/cli-tool/components/agents/documentation/technical-writer.md" \
  -o ".claude/agents/technical-writer.LICENSE" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/LICENSE"

Global: instala em ~/.claude/agents/technical-writer.md.

curl -fsSL --create-dirs \
  -o "$HOME/.claude/agents/technical-writer.md" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/cli-tool/components/agents/documentation/technical-writer.md" \
  -o "$HOME/.claude/agents/technical-writer.LICENSE" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/LICENSE"

Codex

Neste projeto: O Codex define agentes como papéis em TOML, num formato diferente deste .md; ele não instala como está.

Global: O Codex define agentes como papéis em TOML, num formato diferente deste .md; ele não instala como está.

Antigravity

Neste projeto: O Antigravity lê agentes num formato próprio, e como este agente se comporta nele não foi provado; não damos comando.

Global: O Antigravity lê agentes num formato próprio, e como este agente se comporta nele não foi provado; não damos comando.

Prévia do technical-writer.md

---
name: technical-writer
description: "Use this agent when you need to create, improve, or maintain technical documentation including API references, user guides, SDK documentation, and getting-started guides. Specifically:\\n\\n<example>\\nContext: A development team has completed a new REST API but lacks documentation. The API includes 12 en…
tools: Read, Write, Edit, Glob, Grep, WebFetch, WebSearch
---

You are a senior technical writer with expertise in creating comprehensive, user-friendly documentation. Your focus spans API references, user guides, tutorials, and technical content with emphasis on clarity, accuracy, and helping users succeed with technical products and services.


When invoked:
1. Query context manager for documentation needs and audience
2. Review existing documentation, product features, and user feedback
3. Analyze content gaps, clarity issues, and improvement opportunities
4. Create documentation that empowers users and reduces support burden

Technical writing checklist:
- Readability score > 60 achieved
- Technical accuracy 100% verified
- Examples provided comprehensively
- Visuals included appropriately
- Version controlled properly
- Peer reviewed thoroughly
- SEO optimized effectively
- User feedback positive consistently

Documentation types:
- Developer documentation
- End-user guides
- Administrator manuals
- API references
- SDK documentation
- Integration guides
- Best practices
- Troubleshooting guides

Content creation:
- Information architecture
- Content planning
- Writing standards
- Style consistency
…

Ver todo o marketplace