Agent skill

Docs Sync

by ncatbot in ncatbot/NcatBot

整体/局部防腐检查:Docs 内部链接断裂、README 索引不同步、guide↔reference 内容不一致、examples 导入过时、Code↔Docs API 对齐。逐文件检查,最大化并发 subagent。Use when: docs 防腐、docs 链接、docs 断链、断链检查、docs 审计、docs audit、code docs 对齐、reference 过时、guide…

Custom licenceAuto-check passedAgent Workflows

Install Docs Sync

skills CLI
$ npx skills add ncatbot/NcatBot --skill docs-sync -a claude-code

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

GitHub CLI
$ gh skill install ncatbot/NcatBot docs-sync --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/ncatbot/NcatBot.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs-sync .claude/skills/docs-sync && 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
docs-sync
GitHub stars
115
Token cost
~1.3k tokens
SKILL.md length
395 words
Files
6 (incl. references)
Skills in repo
12
Repo updated
First seen
Licence
Custom licence

At a glance

整体/局部防腐检查:Docs 内部链接断裂、README 索引不同步、guide↔reference 内容不一致、examples 导入过时、Code↔Docs API 对齐。逐文件检查,最大化并发 subagent。Use when: docs 防腐、docs 链接、docs 断链、断链检查、docs 审计、docs audit、code docs 对齐、reference 过时、guide…

  • Works in 7 steps: :枚举 → :Phase A — Docs 内部链接完整性(并发,每章节一个 Explore… → (并发):Phase D — Code↔Docs 防腐检查(并发,10 个… → …
  • : docs 防腐、docs 链接、docs 断链、断链检查、docs 审计、docs audit、code docs 对齐、reference 过时、guide reference 不同步、examples 检查、定期检查
  • SKILL.md covers 工作流, 协作技能, Severity 分级 and VuePress 链接语法, plus 1 more section
  • Calls python

What it does

Docs Sync is an agent skill from ncatbot/NcatBot. 整体/局部防腐检查:Docs 内部链接断裂、README 索引不同步、guide↔reference 内容不一致、examples 导入过时、Code↔Docs API 对齐。逐文件检查,最大化并发 subagent。Use when: docs 防腐、docs 链接、docs 断链、断链检查、docs 审计、docs audit、code docs 对齐、reference 过时、guide reference 不同步、examples 检查、定期检查。

Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. The skill folder holds 7 other files, including reference files (for example `references/checks.md`, `references/link-syntax.md` and `references/report-template.md`).

It sits in Agent Workflows, covering Subagents and Technical documentation. The repository describes itself as: NapCat Python SDK;快速开发你的 QQ 机器人.

When your agent uses it

  • : docs 防腐、docs 链接、docs 断链、断链检查、docs 审计、docs audit、code docs 对齐、reference 过时、guide reference 不同步、examples 检查、定期检查
  • Tasks that involve Subagents
  • Tasks that involve Technical documentation

Example prompts

  • “/docs-sync”

Requirements

  • Python 3

Workflow steps

7 steps, taken from the step headings in SKILL.md.

  1. :枚举
  2. :Phase A — Docs 内部链接完整性(并发,每章节一个 Explore subagent,约 25 个)
  3. (并发):Phase D — Code↔Docs 防腐检查(并发,10 个 Explore subagent)
  4. :Phase B — guide↔reference 内容对齐(并发,约 8 个 Explore subagent)
  5. (并发):Phase C — examples 导入有效性(并发,每 example 目录一个 Explore subagent)
  6. :汇总
  7. :修复

What it can do on your machine

Read from SKILL.md and the folder at commit c26300a. 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

    Shell commands in SKILL.md call:

    • python

    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

Docs Sync loads about 1.3k tokens when it runs, and up to ~2.8k if it reads all its reference files. Until then it costs about 60 tokens; SKILL.md has 395 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~60
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~2.8k

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

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 395 words (~1,255 tokens).

name
docs-sync

Read the full SKILL.md on GitHub

Files

SKILL.md and 5 other files (references) in .agents/skills/docs-sync of ncatbot/NcatBot.

  • SKILL.md
  • references/checks.md
  • references/link-syntax.md
  • references/report-template.md
  • reports/2026-03-19_full-audit.md
  • reports/2026-03-24_code_docs_audit.md

Open the folder on GitHubat commit c26300a

Compare with similar skills

Docs Sync 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.

Docs Sync compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Sync this skillncatbot/NcatBot115—~1.3kAutomated safety check: PassCustom licence
Document Featureiopsystems/rezolus275—~2.2kAutomated safety check: PassCustom licence
Codebase Question ResearchWirasm/prp2.3k—~2.8kAutomated safety check: PassMIT
Olore Claude Code Latestolorehq/olore103—~901Automated safety check: PassMIT
Technical Documentationvincentkoc/dotskills107—~2.4kAutomated safety check: PassMIT
Module Analyzer Generate DocLeoYeAI/openclaw-master-skills2.2k—~3.4kAutomated safety check: PassMIT

Similar skills

  • Document Feature

    iopsystems/rezolus

    Write or update the CLI --help text and README section for a new or changed rezolus feature (a subcommand, flag, mode, or behavior change), then prove the help is usable by dispatching a fresh…

    275 GitHub stars~2.2k tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Answers how-and-where questions about a codebase by running parallel explorer agents and writing a research document where every claim cites file and line.

    2.3k GitHub stars~2.8k tokensUpdated 5 days ago
    Agent WorkflowsAuto-check passed
  • Local claude-code documentation reference (latest). An agent skill from olorehq/olore.

    103 GitHub stars~901 tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Technical Documentation

    vincentkoc/dotskills

    Build, review, and audit technical docs and agent instruction files.

    107 GitHub stars~2.4k tokensUpdated 5 days ago
    Agent WorkflowsAuto-check passed
  • Module Analyzer Generate Doc

    LeoYeAI/openclaw-master-skills

    Java/Maven single-module deep documentation generator. An agent skill from LeoYeAI/openclaw-master-skills.

    2.2k GitHub stars~3.4k tokensUpdated 2 mo ago
    Agent WorkflowsAuto-check passed
  • Claude Docs Consultant

    centminmod/my-claude-code-setup

    Consult official Claude Code documentation from code.claude.com using selective fetching.

    2.7k GitHub stars~959 tokensUpdated 9 days ago
    Agent WorkflowsAuto-check passed

More from ncatbot/NcatBot

All 12 skills in this repo
  • Code Nav

    ncatbot/NcatBot

    定位 NcatBot 代码实现:锁定模块目录、找到关键类/函数、追踪调用链。当文档不够时才读代码,用搜索而非遍历。Use when: 找代码实现、哪个文件、哪个类、追踪调用链、定位 bug 行号、代码在哪、模块目录、源码定位。

    115 GitHub stars~460 tokensUpdated 3 days ago
    Auto-check passed
  • Docs Maintenance

    ncatbot/NcatBot

    维护 NcatBot 项目文档、示例、Skills 知识资产。编写/编辑文档、修复文档问题、文档结构规范审查。Use when: 写文档、改文档、新增文档、修复断链、修复索引、修复代码块标注、文档规范、文档模板、文档结构设计、docs maintenance。

    115 GitHub stars~722 tokensUpdated 3 days ago
    Auto-check passed
  • Framework Usage

    ncatbot/NcatBot

    使用 NcatBot 框架开发 QQ 机器人或跨平台 Bot。当用户需要快速体验、创建插件、注册事件处理、发送消息、调用 Bot API、使用 Mixin/Hook、使用 CLI 工具、编写插件测试、或调试运行问题时触发此技能。Use when: 开发…

    115 GitHub stars~1.2k tokensUpdated 3 days ago
    Auto-check passed
  • Plugin Migration

    ncatbot/NcatBot

    将 NcatBot 4.4/4.5 版本插件迁移到 5.0。包括导入路径、注册方式、Config/Data API、事件类型、消息构造的全面映射。Use when: 迁移插件、升级插件、4 转 5、老版本、旧版本、migration、upgrade、plugin migration、版本升级。

    115 GitHub stars~1.2k tokensUpdated 3 days ago
    Auto-check passed
  • Release

    ncatbot/NcatBot

    发布 NcatBot 新版本到 PyPI 和 GitHub Release,或仅编排 Commit 推送到 main。从工作区变更编排 commit 到最终发布的全链路流程。Use when: 发版、release、发布、changelog、版本号、pick commits、挑选提交、release notes、编排 commit、push、推送。

    115 GitHub stars~513 tokensUpdated 3 days ago
    Auto-check passed
  • Skills Sync

    ncatbot/NcatBot

    检查、报告、修复 Skills 间链接内容不同步,以及 Skills↔Docs 内容链接不同步。逐文件检查,最大化并发 subagent。Use when: skill 同步、skill 断链、skill 引用、skill 过时、skill audit、skills 一致性、skill 检查、skill↔docs。

    115 GitHub stars~694 tokensUpdated 3 days ago
    Auto-check passed

Questions about Docs Sync

What does Docs Sync do?

整体/局部防腐检查:Docs 内部链接断裂、README 索引不同步、guide↔reference 内容不一致、examples 导入过时、Code↔Docs API 对齐。逐文件检查,最大化并发 subagent。Use when: docs 防腐、docs 链接、docs 断链、断链检查、docs 审计、docs audit、code docs 对齐、reference 过时、guide…. Docs Sync is an agent skill from ncatbot/NcatBot.

When should I use Docs Sync?

Docs Sync fits situations like: : docs 防腐、docs 链接、docs 断链、断链检查、docs 审计、docs audit、code docs 对齐、reference 过时、guide reference 不同步、examples 检查、定期检查; tasks that involve Subagents; tasks that involve Technical documentation.

How do I install Docs Sync in Claude Code?

Run `npx skills add ncatbot/NcatBot --skill docs-sync -a claude-code`. Or copy the skill folder (.agents/skills/docs-sync in ncatbot/NcatBot) into .claude/skills/docs-sync in your project. Claude Code loads it when a task matches its description.

How do I install Docs Sync in Codex?

Run `npx skills add ncatbot/NcatBot --skill docs-sync -a codex`. Or copy the skill folder (.agents/skills/docs-sync in ncatbot/NcatBot) into .agents/skills/docs-sync in your project. Codex loads it when a task matches its description.

Can I use Docs Sync 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 ncatbot/NcatBot --skill docs-sync -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-sync, .gemini/skills/docs-sync, .github/skills/docs-sync and .opencode/skills/docs-sync in your project.

What does Docs Sync need to run?

Going by SKILL.md and its folder, Docs Sync needs the command-line tools its instructions call (python). Our summary lists: Python 3.

Does Docs Sync 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 Docs Sync 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 Docs Sync use?

Docs Sync has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Docs Sync use?

About 1.3k tokens (SKILL.md is roughly 5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 1.6k tokens, read only when the agent opens those files.

What are the alternatives to Docs Sync?

Skills that share tags, products or a category with Docs Sync: Document Feature (iopsystems/rezolus, 275 stars), Codebase Question Research (Wirasm/prp, 2.3k stars), Olore Claude Code Latest (olorehq/olore, 103 stars) and Technical Documentation (vincentkoc/dotskills, 107 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Sync?

ncatbot (a GitHub organization) maintains it in ncatbot/NcatBot, which has 115 GitHub stars. The repository holds 12 skills in this directory. The repository was last updated on October 4, 2026.

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