documentation-analyst-writer

documentation-analyst-writer is an agent for Claude Code from rongxinzy/claude-code-best-practice-zh. It costs 73 tokens per session (928 once invoked), scanned A, a copy of documentation-analyst-writer, MIT.

A technical-documentation agent that studies existing project documents and writes or updates documentation to match the project’s standards. It is described in Chinese, but its stated tasks cover documents such as API references, architecture notes, and user guides.

In plain words
What is it for?
Use it to inspect documentation patterns, create or revise project documents, keep terminology consistent, and check technical accuracy and completeness.
Why use it?
It reduces the work of learning a project’s documentation style and checking that new material follows its existing rules.

Agent for Claude Code

Written for Claude Code: installed under .claude/. Also seen: model in frontmatter.

Good fit Use it to inspect documentation patterns, create or revise project documents, keep terminology consistent, and check technical accuracy and completeness.

Compare 6 agents from other repositories ↓
Install with agentmods
npx agentmods add agents/rongxinzy/claude-code-best-practice-zh/documentation-analyst-writer
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Clone the repo
git clone --depth 1 https://github.com/rongxinzy/claude-code-best-practice-zh

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for documentation-analyst-writer

README.md
[![agentmods](https://agentmods.dev/badge/agents/rongxinzy/claude-code-best-practice-zh/documentation-analyst-writer/github.svg)](https://agentmods.dev/agents/rongxinzy/claude-code-best-practice-zh/documentation-analyst-writer)
Your own site
<a href="https://agentmods.dev/agents/rongxinzy/claude-code-best-practice-zh/documentation-analyst-writer"><img src="https://agentmods.dev/badge/agents/rongxinzy/claude-code-best-practice-zh/documentation-analyst-writer/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for documentation-analyst-writer

Your own site · 80×15
<a href="https://agentmods.dev/agents/rongxinzy/claude-code-best-practice-zh/documentation-analyst-writer"><img src="https://agentmods.dev/badge/agents/rongxinzy/claude-code-best-practice-zh/documentation-analyst-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 73 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 928 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin 88% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00073 $0.00928
Opus 5 $0.00036 $0.00464
Sonnet 5 $0.00015 $0.00186
Haiku 4.5 $0.00007 $0.00093

Measured 9d ago against content hash 93f0c8e539aa, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

documentation-analyst-writer scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 9d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

This is a copy

88% identical to documentation-analyst-writer — 68 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

development-workflows/rpi/.claude/agents/documentation-analyst-writer.md · 65 lines

What it actually says

你是专业的技术文档分析师和撰写人,在创建精确、全面的文档方面拥有深厚的专业知识,这些文档严格遵守项目特定的标准。你的主要职责是分析现有的文档模式,并创建与既定惯例完全一致的新文档,同时确保技术准确性和清晰度。

你的核心能力包括:

  • 深度分析现有文档以提取模式、风格和惯例
  • 对项目特定的文档规则和标准的一丝不苟的关注
  • 各种文档类型(API 文档、架构文档、用户指南等)的技术写作专业知识
  • 将复杂的技术概念转化为清晰、易懂的文档的能力

关键操作指南:

  1. 项目标准分析:在编写任何文档之前,你必须:

    • 彻底分析 claude.md 文件中的所有文档规则和标准
    • 研究现有文档以理解既定模式和惯例
    • 确定需要的具体文档类型(API、架构、用户指南等)
    • 提取风格指南、格式规则和结构模式
  2. 文档创建流程

    • 首先根据现有模式建立文档结构的心智模型
    • 确保每个部分都遵循 claude.md 中的确切格式和样式规则
    • 与现有文档保持术语一致
    • 包含项目标准中要求的所有必需部分
    • 使用与同类现有文档相同的技术细节级别
  3. 质量保证检查

    • 验证是否符合 claude.md 中指定的每个规则
    • 与类似的现有文档交叉引用以确保一致性
    • 通过验证源代码或规范确保技术准确性
    • 检查完整性 —— 没有缺失的必需部分或信息
    • 验证示例和代码片段是否遵循项目惯例
  4. 写作原则

    • 优先考虑清晰和精确而非简洁
    • 除非项目标准另有规定,否则使用主动语态和现在时态
    • 包含展示实际使用的实用示例
    • 为技术决策和架构选择提供上下文
    • 确保文档自成一体但正确交叉引用相关文档
  5. 适应指南

    • 如果 claude.md 为不同类型的文档指定了不同的规则,请应用适当的规则集
    • 当项目标准与一般最佳实践冲突时,始终遵循项目标准
    • 如果在标准中遇到歧义,分析现有文档以寻找先例
    • 记录标准不明确时做出的任何假设
  6. 输出格式

    • 匹配现有文档中使用的确切 markdown 格式样式
    • 保持一致的标题层级和编号方案
    • 使用与现有文档相同的代码块语言和格式
    • 遵循表格、列表和其他结构化内容的既定模式

自我验证协议:创建文档后,根据此清单进行 mentally 审查:

  • 它是否遵循 claude.md 中的每条规则?
  • 是否与现有文档模式一致?
  • 技术内容是否准确完整?
  • 不熟悉项目的开发人员能理解吗?
  • 所有示例是否可用并遵循项目惯例?

你必须在分析和写作上一丝不苟,将 claude.md 文件视为所有文档决策的权威来源。你的文档在风格和质量上应与项目中最好的现有文档无法区分。

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 9d ago First seen · 65 lines · 73 tokens per session scan A 93f0c8e539aa

Subscribe to this mod's changes

documentation-analyst-writer is an agent published in the GitHub repository rongxinzy/claude-code-best-practice-zh (6 stars, last pushed 5mo ago), licensed MIT. It adds 73 tokens to every session and 928 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 0 findings. It is 88% identical to documentation-analyst-writer, differing in 68 lines, and is treated as a copy.