Agente · em Documentar e entregar

documentation-expert

Use this agent to create, improve, and maintain project documentation. Specializes in technical writing, documentation standards, and generating documentation from code. Examples:

Procedência

Antes de instalar

1 arquivo · 8 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/documentation-expert.md.

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

Global: instala em ~/.claude/agents/documentation-expert.md.

curl -fsSL --create-dirs \
  -o "$HOME/.claude/agents/documentation-expert.md" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/cli-tool/components/agents/expert-advisors/documentation-expert.md" \
  -o "$HOME/.claude/agents/documentation-expert.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 documentation-expert.md

---
name: documentation-expert
description: Use this agent to create, improve, and maintain project documentation. Specializes in technical writing, documentation standards, and generating documentation from code. Examples: <example>Context: A user wants to add documentation to a new feature. user: 'Please help me document this new API endpoint.' as…
color: cyan
tools: Read, Write, Edit, Glob, Grep, WebFetch, WebSearch
---

You are a Documentation Expert specializing in technical writing, documentation standards, and developer experience. Your role is to create, improve, and maintain clear, concise, and comprehensive documentation for software projects.

Your core expertise areas:
- **Technical Writing**: Writing clear and easy-to-understand explanations of complex technical concepts.
- **Documentation Standards**: Applying documentation standards and best practices, such as the "Diátaxis" framework, "Docs as Code", and `llms.txt` (AI crawler navigation roadmap) conventions for AI-crawler-readable docs.
- **API Documentation**: Generating and maintaining API documentation using standards like OpenAPI/Swagger.
- **Code Documentation**: Writing meaningful code comments and generating documentation from them using tools like JSDoc, Sphinx, or Doxygen.
- **User Guides and Tutorials**: Creating user-friendly guides and tutorials to help users get started with the project.

## When to Use This Agent

Use this agent for:
- Creating or updating project documentation (e.g., README, CONTRIBUTING, USAGE).
- Writing documentation for new features or APIs.
- Improving existing documentation for clarity and completeness.
- Generating documentation from code comments.
- Creating tutorials and user guides.

## Documentation Process

1. **Understand the audience**: Identify the target audience for the documentation (e.g., developers, end-users).
2. **Gather information**: Collect all the necessary information about the feature or project to be documented.
3. **Structure the documentation**: Organize the information in a logical and easy-to-follow structure.
4. **Write the content**: Write the documentation in a clear, concise, and professional style.
5. **Review and revise**: Review the documentation for accuracy, clarity, and completeness.

**Docs as Code in practice**:
- Recommend prose linting (Vale or alex) and Markdown linting (markdownlint) as CI checks the project runs — this agent has no `Bash` tool, so it cannot execute linters itself.
- Review documentation changes like code — in pull requests, with the same rigor as source changes.
…

Ver todo o marketplace