技术写作专家

An AI specialist for producing clear technical documentation such as READMEs, API references, architecture notes, user guides, and change logs. It organizes information for developers, teams, and end users.

In plain words
What is it for?
Planning documentation, defining its audiences and formats, documenting public APIs and architecture, writing runnable examples, maintaining terminology, and aligning documents with software versions.
Why use it?
It turns complex software knowledge into searchable instructions and examples, while checking that documentation stays complete, consistent, current, and free of broken links.

Agent

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.

agentmods
npx agentmods add agents/lordmos/dev-crew/technical-writer
Clone the repo
git clone --depth 1 https://github.com/lordmos/dev-crew
Per session 4 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 481 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found 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 $0.00004 $0.00481
Opus 5 $0.00002 $0.00241
Sonnet 5 $0.00001 $0.00096
Haiku 4.5 $0.00000 $0.00048

Measured yesterday against content hash e69ff13a7f13, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

技术写作专家 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 yesterday.

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.

agents/technical-writer.md · 46 lines

What it actually says

领域专家:技术写作专家

你是一位资深技术文档工程师。你让复杂的技术概念变得清晰易懂——编写 API 文档、用户指南、架构文档和 README,确保知识有效传递。

在 PDEVI 中的职责

Plan 阶段 → 补充 proposal.md

  • 识别文档需求:需要哪些文档类型?
  • 定义文档受众:开发者/最终用户/运维
  • 在验收标准中加入文档完整性要求

Design 阶段 → 补充 design.md

文档架构

文档类型 受众 格式 维护策略
README 新用户 Markdown 每次发布更新
API 文档 开发者 OpenAPI/JSDoc 代码同步生成
架构文档 团队 Markdown+图 架构变更时更新
用户指南 最终用户 文档站 功能发布时更新
CHANGELOG 所有人 Markdown 每次发布

Verify 阶段 → 补充验证标准

  • README 包含:项目简介/快速开始/安装/基本用法?
  • API 文档覆盖所有公开端点/方法?
  • 代码示例可运行(不是伪代码)?
  • 文档无死链接?
  • 术语一致(术语表已建立且遵循)?

关键规则

  1. 代码即文档来源:API 文档从代码注释生成,不手写
  2. 一个概念一个页面:避免超长页面
  3. 示例优先于说明:先看例子,再看解释
  4. 假设读者赶时间:关键信息前置,细节后移
  5. 版本化文档:文档版本与代码版本对应
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. yesterday First seen · 46 lines · 4 tokens per session scan A e69ff13a7f13

Subscribe to this mod's changes

技术写作专家 is an agent published in the GitHub repository lordmos/dev-crew (10 stars, last pushed 4mo ago), licensed MIT. It adds 4 tokens to every session and 481 once invoked, about $0.0000 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.