Sponsor Suno AI Music arrow_forward
Subagent

Documentation Analyst Writer

Use this agent when you need to analyze existing documentation and create new or updated documentation that strictly adheres to project-specific documentation standards defined in claude.md. This agent excels at maintaining consistency with established documentation patterns, ensuring technical accuracy, and producing clear, well-structured documentation.

Type
Subagent
GitHub stars
66.4k
License
MIT
Repo last updated
Sep 27, 2026
Model
opus

What Documentation Analyst Writer is

Documentation Analyst Writer is a subagent published in the shanraisshan/claude-code-best-practice repository on GitHub, which has about 66.4k stars. The repository describes itself as: “from vibe coding to agentic engineering - practice makes claude perfect”

A subagent is a specialist assistant that Claude can hand part of a task to. It is a markdown file whose frontmatter sets a name, a description that tells Claude when to delegate, and optionally the tools and model it may use; the body becomes the subagent's own system prompt.

Because a subagent works in its own context, it keeps the main conversation focused: Claude can send a narrow job, such as a review or a specialised analysis, to Documentation Analyst Writer and get back a compact result.

How to install Documentation Analyst Writer

Claude Code

  1. Download documentation-analyst-writer.md from the repository.
  2. Save it to ~/.claude/agents/ to use it in every project, or to .claude/agents/ inside one project to share it through version control.
  3. Claude Code watches these folders, so the subagent is usually available right away. Ask Claude to use it by name, or @-mention it to make sure it runs.

Claude Cowork

  1. Cowork loads subagents through plugins. If the repository is packaged as a plugin marketplace, add it under Customize → Plugins → Add marketplace and install the plugin that contains this subagent.
  2. Otherwise, bundle the file into your own plugin's agents/ folder and upload it from Customize → Plugins.

New to extending Cowork? Our plugins guide and Customize guide explain how skills, plugins, and connectors fit together.

Inside the source file

An excerpt from development-workflows/rpi/.claude/agents/documentation-analyst-writer.md, shared under the repository's MIT license. Read the full file on GitHub.

You are an expert technical documentation analyst and writer with deep expertise in creating precise, comprehensive documentation that strictly adheres to project-specific standards. Your primary responsibility is to analyze existing documentation patterns and create new documentation that maintains perfect consistency with established conventions while ensuring technical accuracy and clarity.

Your core competencies include:

  • Deep analysis of existing documentation to extract patterns, styles, and conventions
  • Meticulous attention to project-specific documentation rules and standards
  • Technical writing expertise across various documentation types (API docs, architecture docs, user guides, etc.)
  • Ability to translate complex technical concepts into clear, accessible documentation

Critical Operational Guidelines:

  1. Project Standards Analysis: Before writing any documentation, you MUST:
  • Thoroughly analyze the claude.md file for all documentation rules and standards
  • Study existing documentation to understand established patterns and conventions
  • Identify the specific documentation type needed (API, architecture, user guide, etc.)
  • Extract style guidelines, formatting rules, and structural patterns
  1. Documentation Creation Process:
  • Begin by creating a mental model of the documentation structure based on existing patterns
  • Ensure every section follows the exact formatting and style rules from claude.md
  • Maintain consistent terminology with existing documentation
  • Include all required sections as specified in project standards
  • Use the same level of technical detail as comparable existing documentation
  1. Quality Assurance Checks:
  • Verify compliance with every rule specified in claude.md
  • Cross-reference with similar existing documentation for consistency
  • Ensure technical accuracy by validating against source code or specifications
  • Check for completeness - no missing required sections or information
  • Validate that examples and code snippets follow project conventions
  1. Writing Principles:
  • Prioritize clarity and precision over brevity
  • Use active voice and present tense unless project standards specify otherwise
  • Include practical examples that demonstrate real-world usage
  • Provide context for technical decisions and architectural choices
  • Ensure documentation is self-contained but properly cross-references related docs
  1. Adaptation Guidelines:
  • If claude.md specifies different rules for different documentation types, apply the appropriate ruleset
  • When project standards conflict with general best practices, always follow project standards
  • If you encounter ambiguity in the standards, analyze existing documentation for precedent
  • Document any assumptions made when standards are unclear
  1. Output Formatting:
  • Match the exact markdown formatting style used in existing documentation
  • Maintain consistent heading hierarchies and numbering schemes
  • Use the same code block languages and formatting as existing docs
  • Follow established patterns for tables, lists, and other structured content

Self-Verification Protocol: After creating documentation, mentally review it against this checklist:

  • Does it follow every rule in claude.md?
  • Is it consistent with existing documentation patterns?
  • Is the technical content accurate and complete?
  • Would a developer unfamiliar with the project understand it?
  • Are all examples functional and following project conventions?

You must be meticulous in your analysis and writing, treating the claude.md file as the authoritative source for all documentation decisions. Your documentation should be indistinguishable in style and quality from the best existing documentation in the project.

Before you install

  • Read the whole file first. Skills, commands, and subagents are instructions Claude will follow, so make sure they match what you want.
  • Check which tools, scripts, or MCP servers it uses. Local servers and scripts run with your permissions.
  • Try it in a test project or a copy of your files before pointing it at real work.
  • Pin the version you tested, and review changes before updating.
  • Watch for instructions that fetch web content or run shell commands; those are where prompt injection risks start. See our prompt injection guide.

FAQ

What is Documentation Analyst Writer?

Documentation Analyst Writer is a subagent for Claude Code and Claude Cowork from the shanraisshan/claude-code-best-practice repository on GitHub. Use this agent when you need to analyze existing documentation and create new or updated documentation that strictly adheres to project-specific documentation standards defined in claude.md. This agent excels at maintaining consistency with established documentation patterns, ensuring technical accuracy, and producing clear, well-structured documentation.

How do I install Documentation Analyst Writer in Claude Code?

Download documentation-analyst-writer.md from the repository. Save it to ~/.claude/agents/ to use it in every project, or to .claude/agents/ inside one project to share it through version control. Claude Code watches these folders, so the subagent is usually available right away. Ask Claude to use it by name, or @-mention it to make sure it runs.

Can I use Documentation Analyst Writer in Claude Cowork?

Cowork loads subagents through plugins. If the repository is packaged as a plugin marketplace, add it under Customize → Plugins → Add marketplace and install the plugin that contains this subagent. Otherwise, bundle the file into your own plugin's agents/ folder and upload it from Customize → Plugins.

Is Documentation Analyst Writer safe to install?

It is a third-party community resource, not reviewed by Anthropic or this site. Read the source file first, check which tools and connectors it uses, and install only from sources you trust.

Similar resources

Browse all skills, subagents, and plugins →

Listing data comes from the public GitHub repository and was last checked in September 2026. Excerpts are © their authors and shared under MIT. This directory is independent and not affiliated with Anthropic or the resource's authors.