Agent skill

Documentation Specialist

by CaoMeiYouRen in CaoMeiYouRen/caomei-auth

查阅、生成、更新、对齐和审校项目文档时使用。适用于 README、设计说明、变更说明、技能文档、计划文档与规范文档,不假设文档一定在 docs/ 目录下。用户提到 docs、documentation、README、设计文档、同步文档、更新说明时都应触发。

MITAuto-check passedDevelopment

Install Documentation Specialist

skills CLI
$ npx skills add CaoMeiYouRen/caomei-auth --skill documentation-specialist -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install CaoMeiYouRen/caomei-auth documentation-specialist --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/CaoMeiYouRen/caomei-auth.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.github/skills/documentation-specialist .claude/skills/documentation-specialist && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
documentation-specialist
GitHub stars
220
Token cost
~275 tokens
SKILL.md length
59 words
Files
1
Skills in repo
14
Repo updated
First seen
Licence
MIT

At a glance

查阅、生成、更新、对齐和审校项目文档时使用。适用于 README、设计说明、变更说明、技能文档、计划文档与规范文档,不假设文档一定在 docs/ 目录下。用户提到 docs、documentation、README、设计文档、同步文档、更新说明时都应触发。

  • Tasks that involve Technical documentation
  • SKILL.md covers 工作流, 关注点, 项目特化提示 and 反模式, plus 1 more section
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Documentation Specialist is an agent skill from CaoMeiYouRen/caomei-auth. 查阅、生成、更新、对齐和审校项目文档时使用。适用于 README、设计说明、变更说明、技能文档、计划文档与规范文档,不假设文档一定在 docs/ 目录下。用户提到 docs、documentation、README、设计文档、同步文档、更新说明时都应触发。

Its SKILL.md is about 280 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation. The repository describes itself as: 草梅 Auth 是一个基于 Nuxt 全栈框架的统一登录平台。支持 OAuth2.0 协议,集成邮箱、用户名、手机号、验证码、社交媒体等多种登录注册方式。 The licence is MIT.

When your agent uses it

  • Tasks that involve Technical documentation

Example prompts

  • “/documentation-specialist”

What it can do on your machine

Read from SKILL.md and the folder at commit 7bd3bae. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Documentation Specialist loads about 275 tokens when it runs. Until then it costs about 38 tokens; SKILL.md has 59 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~38
When it runs · the whole SKILL.md, loaded when a task matches
~275

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from CaoMeiYouRen/caomei-auth at commit 7bd3bae, republished under its MIT licence (© CaoMeiYouRen). 59 words, ~275 tokens.

Download SKILL.mdSave it as .claude/skills/documentation-specialist/SKILL.md (or your agent's skills folder).
name
documentation-specialist
description
查阅、生成、更新、对齐和审校项目文档时使用。适用于 README、设计说明、变更说明、技能文档、计划文档与规范文档,不假设文档一定在 docs/ 目录下。用户提到 docs、documentation、README、设计文档、同步文档、更新说明时都应触发。
metadata.internal
true

Documentation Specialist

铁律:不要把文档写成愿景或猜测。文档必须反映代码、配置和决策的当前事实。

工作流

  • Step 1: 确认文档类型 ⚠️ REQUIRED
    • 1.1 判断这是规范文档、设计说明、使用说明、变更记录还是技能文档。
    • 1.2 明确读者是谁,以及文档需要回答什么问题。
  • Step 2: 收集权威来源 ⚠️ REQUIRED
    • 2.1 从代码、配置、现有文档和提交意图中提取事实。
    • 2.2 当事实不充分时,先标记未知点,不要自行脑补。
  • Step 3: 组织内容
    • 3.1 先写结构,再补细节、命令、示例和链接。
    • 3.2 需要交叉引用时,保证路径和标题真实可用。
  • Step 4: 做同步检查
    • 4.1 核对文档是否与当前代码和工作流一致。
    • 4.2 如果代码已变更但文档无法完整更新,明确写出缺口。

关注点

  • 标题是否准确反映读者任务。
  • 示例命令是否真实可执行。
  • 链接、路径、技能名和脚本名是否存在。
  • 文档是否说明限制、前提和后续动作。

项目特化提示

  • 如果仓库中存在 docs/,优先检查 standards/、design/、plan/ 等子目录,而不是假设所有文档都在根目录。
  • 需要图表时优先使用 Mermaid,而不是嵌入难维护的图片描述。
  • 当代码或技能流程发生重大变化时,优先更新 README、设计文档和技能文档中的命令与路径。

反模式

  • 假设 docs/ 一定存在,并围绕不存在的目录写文档。
  • 复制代码结构却不解释为什么这样设计。
  • 用口号替代操作步骤和限制条件。

交付前检查

  • 文档结论都有代码、配置或既有文档作为依据。
  • 路径、链接、技能名和命令都已核对。
  • 已明确文档面向的读者和使用场景。
  • 未把未知信息伪装成既定事实。

© CaoMeiYouRen, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .github/skills/documentation-specialist of CaoMeiYouRen/caomei-auth.

Open the folder on GitHubat commit 7bd3bae

Compare with similar skills

Documentation Specialist next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Documentation Specialist compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Documentation Specialist this skillCaoMeiYouRen/caomei-auth220—~275Automated safety check: PassMIT
Diagram Designcathrynlavery/diagram-design48k1 repos~7.6kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.5kAutomated safety check: PassGPL-3.0
Draw.io Diagram StudioAgents365-ai/drawio-skill10k—~2.4kAutomated safety check: NotesMIT

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    48k GitHub starsUsed in 1 repo~7.6k tokens
    DevelopmentAuto-check passed
  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed
  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 8 days ago
    DevelopmentAuto-check: notes
  • Dark Architecture Diagram Builder

    Cocoon-AI/architecture-diagram-generator

    Creates dark-themed system, cloud, security and network architecture diagrams as self-contained HTML files with inline SVG and CSS.

    7.4k GitHub starsUsed in 1 repo~2.1k tokens
    DevelopmentAuto-check passed

More from CaoMeiYouRen/caomei-auth

All 14 skills in this repo
  • Code Reviewer

    CaoMeiYouRen/caomei-auth

    审查当前 git 变更、PR、提交范围、技能定义文件、架构调整或安全敏感代码时使用。输出结构化 Review Gate 结论(Pass/Reject)、问题分级(blocker/warning/suggest)、最低验证矩阵、证据链与复查基线。覆盖正确性、安全、架构、SOLID、可删除代码、性能、异常处理与测试风险;默认只输出 review,不直接修改代码。用户提到 review、code…

    220 GitHub stars~1.5k tokensUpdated 9 days ago
    Auto-check passed
  • Full Stack Master

    CaoMeiYouRen/caomei-auth

    需要统筹需求澄清、上下文扫描、技术方案、前后端实现、UI 验证、测试、质量审查、文档同步和提交节奏时使用。它负责编排多技能协作,而不是亲自替代所有专业技能。用户提到 end-to-end workflow、全流程开发、从需求到提交、PDTFC+、多技能编排时都应触发。

    220 GitHub stars~1k tokensUpdated 9 days ago
    Auto-check passed
  • Quality Guardian

    CaoMeiYouRen/caomei-auth

    运行并解读 lint、类型检查、测试等质量门时使用。它不只是执行命令,还要根据变更范围选择最小充分检查、分析失败原因,并给出是否允许继续提交或发布的判断。用户提到 lint、typecheck、tests、quality gate、验证改动时都应触发。

    220 GitHub stars~358 tokensUpdated 9 days ago
    Auto-check passed
  • Devops Specialist

    CaoMeiYouRen/caomei-auth

    修改 Docker、CI/CD、部署配置、环境变量、运行时参数、构建脚本和发布流程时使用。优先覆盖 Docker、Vercel、Cloudflare 与 GitHub Actions 场景。用户提到 deploy、Dockerfile、workflow、CI、CD、environment variables、build pipeline、release config 时都应触发。

    220 GitHub stars~446 tokensUpdated 9 days ago
    Auto-check: notes
  • Gh CLI

    CaoMeiYouRen/caomei-auth

    使用 GitHub CLI(gh)处理仓库、issue、pull request、workflow、project、release、codespace、gist、search、api、auth、config、alias、secret、variable、extension、ruleset 和 status 等命令行操作时使用。用户提到 gh、gh cli、GitHub CLI、gh…

    220 GitHub stars~460 tokensUpdated 9 days ago
    Auto-check passed
  • Backend Expert

    CaoMeiYouRen/caomei-auth

    设计或实现后端 API、服务层、数据库读写、鉴权权限控制、输入校验、事务处理与错误处理时使用。用户提到 API、route、handler、server、auth、permission、drizzle、database、zod、Hono、Nuxt server routes、backend bug 修复时都应触发。

    220 GitHub stars~329 tokensUpdated 9 days ago
    Auto-check passed

Categories

Questions about Documentation Specialist

What does Documentation Specialist do?

查阅、生成、更新、对齐和审校项目文档时使用。适用于 README、设计说明、变更说明、技能文档、计划文档与规范文档,不假设文档一定在 docs/ 目录下。用户提到 docs、documentation、README、设计文档、同步文档、更新说明时都应触发。. Documentation Specialist is an agent skill from CaoMeiYouRen/caomei-auth.

When should I use Documentation Specialist?

Documentation Specialist fits situations like: tasks that involve Technical documentation.

How do I install Documentation Specialist in Claude Code?

Run `npx skills add CaoMeiYouRen/caomei-auth --skill documentation-specialist -a claude-code`. Or copy the skill folder (.github/skills/documentation-specialist in CaoMeiYouRen/caomei-auth) into .claude/skills/documentation-specialist in your project. Claude Code loads it when a task matches its description.

How do I install Documentation Specialist in Codex?

Run `npx skills add CaoMeiYouRen/caomei-auth --skill documentation-specialist -a codex`. Or copy the skill folder (.github/skills/documentation-specialist in CaoMeiYouRen/caomei-auth) into .agents/skills/documentation-specialist in your project. Codex loads it when a task matches its description.

Can I use Documentation Specialist in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add CaoMeiYouRen/caomei-auth --skill documentation-specialist -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation-specialist, .gemini/skills/documentation-specialist, .github/skills/documentation-specialist and .opencode/skills/documentation-specialist in your project.

What does Documentation Specialist need to run?

SKILL.md names no scripts, command-line tools or credentials: Documentation Specialist is instructions for the agent only.

Does Documentation Specialist access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Documentation Specialist safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Documentation Specialist use?

Documentation Specialist is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Documentation Specialist use?

About 275 tokens (SKILL.md is roughly 1.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Documentation Specialist?

Skills that share tags, products or a category with Documentation Specialist: Diagram Design (cathrynlavery/diagram-design, 48k stars), Simple English (moeru-ai/airi, 50k stars), Doc Sync (JetBrains/ideavim, 10k stars) and Mailspring App Screenshots (Foundry376/Mailspring, 18k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Documentation Specialist?

CaoMeiYouRen (a GitHub user) maintains it in CaoMeiYouRen/caomei-auth, which has 220 GitHub stars. The repository holds 14 skills in this directory. The repository was last updated on October 1, 2026.

Source: CaoMeiYouRen/caomei-auth on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.