doc-sync-check

doc-sync-check is a skill for Claude Code from zuoyebang/aiweave. It costs 116 tokens per session (3,254 once invoked), scanned A, original, Apache-2.0.

A documentation audit tool that compares project documents with the code and checks several linked records, such as routes, database models, and service methods. It also scans selected rules and configuration areas for omissions or unsafe patterns.

In plain words
What is it for?
Use it for a full or scoped review of docs and code, including API, service, model, middleware, routing, Redis-key, security, deployment, and lifecycle documentation.
Why use it?
It helps find documentation that is missing, outdated, unregistered, or inconsistent with the implementation. It reduces the need to discover these mismatches manually during maintenance or review.

Skill for Claude Code

Written for Claude Code: disable-model-invocation in frontmatter. Also seen: mentions CLAUDE.md.

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 skills/zuoyebang/aiweave/doc-sync-check
Any agent
npx skills add zuoyebang/aiweave --skill doc-sync-check
Clone the repo
git clone --depth 1 https://github.com/zuoyebang/aiweave

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 doc-sync-check

README.md
[![agentmods](https://agentmods.dev/badge/skills/zuoyebang/aiweave/doc-sync-check.svg)](https://agentmods.dev/skills/zuoyebang/aiweave/doc-sync-check)
Your own site
<a href="https://agentmods.dev/skills/zuoyebang/aiweave/doc-sync-check"><img src="https://agentmods.dev/badge/skills/zuoyebang/aiweave/doc-sync-check.svg" alt="Measured on agentmods" height="20"></a>
Per session 116 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,254 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.1 $0.00116 $0.03254
Opus 5 $0.00058 $0.01627
Sonnet 5 $0.00023 $0.00651
Haiku 4.5 $0.00012 $0.00325

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

Security

Grade A, and why

doc-sync-check 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 6d 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.

templates/skills/doc-sync-check/SKILL.md · 154 lines

How it starts

The opening of the file, as written. The whole thing — 154 lines — stays where its author put it; the contents beside it link to each section on GitHub.

检查文档与代码的一致性。范围:$ARGUMENTS(空或 all 则全量)。

公共步骤模板见 skills-spec/01_skill_authoring_guide.md §A-§E。本 Skill 不生成代码,故第 5 步测试同步不适用,但仍需读 §A-§C。

第 0 步:🚫 模块特殊规则(§A 之扩展)

当前阶段的 🚫 模块(BUILD_STATUS.md §0):

  • 代码侧:相关代码文件不存在是预期报"代码缺失"
  • 文档侧:相关 md 完整保留是预期报"文档多余"
  • 输出时把 🚫 项独立成"已知跳过项"小节

第 1 步:读取范围判定表(公共必读见 §B)

CLAUDE.md「范围判定表」——它是"代码路径 ↔ 文档路径"的完整双向映射。

第 2 步:9 维度检查

维度 1:代码存在但文档缺失(最严重)

  • 扫描 controllers/http/{audience}/ 下所有 .go → 检查 docs/api/ 对应文档
  • 扫描 service/ 下所有 public 方法 → 检查 docs/service/service_design.md
  • 扫描 models/ 下所有 struct → 检查 docs/schema/database_design.md,逐字段对比
  • 扫描 middleware/ → 检查 docs/architecture/middleware.md
  • 扫描 router/command.go 注册的命令 → 检查 docs/service/scheduled_tasks_design.md
  • 扫描 helpers/ 导出函数 → 检查 docs/architecture/helpers_api.md

维度 2:文档存在但代码缺失

  • 扫描 docs/api/ 中接口 → 检查对应 controller
  • 扫描 docs/service/service_design.md 方法 → 检查对应 service
  • 扫描 docs/schema/database_design.md 表 → 检查对应 model

维度 3:INDEX.md 完整性

扫描 docs/ 下所有 .md(递归)→ 检查 docs/INDEX.md 是否登记

维度 4:路由一致性

  • docs/architecture/routing.md §5 完整路由表
  • router/ 下 .go 文件,提取实际注册路由
  • 双向对比

维度 5:Redis Key 一致性

  • docs/cache/cache_design.mddocs/schema/database_design.md §4 提取所有 Key 模式
  • service/controllers/ 中搜索 Redis 操作
  • 检查 Key 名称一致性

维度 6:错误码一致性

  • components/error.go / service_error.go 提取所有定义
  • docs/architecture/status_codes.md 对比

维度 7:测试覆盖

  • 扫描 controllers/http/ 下已实现的 handler
  • 检查 test/cases/{audience}/ 是否有对应测试文件
  • 输出"代码已实现但测试缺失"列表 → 🔴

维度 8:规范主体业务名泄漏(仅当 scope 含 aiweaveall 时启用)

此维度审计 aiweave/docs-spec/*aiweave/skills-spec/* 的"规范主体 vs 参考示例"双轨结构是否被违反。详细规则见 PRINCIPLES.md §12 占位符规则

⚠️ 本维度自身豁免声明(§12.6 #6 meta 内容):本节下方第 2 步的"业务名关键词清单"、第 5 步的"误报抑制规则"是 audit 规则的 meta 内容——这些清单行不参与自身的维度 8 审计。AI 在扫描 templates/skills/doc-sync-check/SKILL.md 时应主动跳过本节内的关键词清单与对照表(按行匹配"Register / Login"类清单格式即可识别)。

Read the full file on GitHub · 154 lines

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. 6d ago First seen · 154 lines · 116 tokens per session scan A bdfa56b2a21b

Subscribe to this mod's changes

doc-sync-check is a skill published in the GitHub repository zuoyebang/aiweave (20 stars, last pushed 2mo ago), licensed Apache-2.0. It adds 116 tokens to every session and 3,254 once invoked, about $0.0006 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-30.

Related

Other skills, from other repositories

build-teaql-app

Build or change a TeaQL application in Java, Rust, Go, Swift, Python, C#/.NET, or TypeScript, including Kotlin/JVM applications that consume Java-generated libraries. Mandatory order: first draft and save a complete KSML model, then verify the client and evaluate that saved model, repair it through repeated evaluation…

teaql/teaql-agent-kit · 112 tokens

build-executor

Govern implementation from an approved execution contract. Invoke when execution-contract.md is approved and the user wants disciplined build work, TDD execution, or guarded batch-by-batch implementation.

MageByte-Zero/spec-superflow · 39 tokens

workflow-start

Primary entry point for the spec-superflow state-machine workflow. Invoke when the user is inside an active spec-superflow change directory (look for .spec-superflow.yaml, changes/ /, proposal.md, specs/, design.md, tasks.md, or execution-contract.md) and asks to start, continue, resume, implement, plan, or figure out…

MageByte-Zero/spec-superflow · 125 tokens

bug-investigator

Use when encountering any bug, test failure, or unexpected behavior during spec-superflow execution, before proposing fixes. Invoked automatically when build-executor hits a blockage.

MageByte-Zero/spec-superflow · 37 tokens

release-archivist

Close out a spec-superflow change with verification, summary, and archive readiness. Invoke when implementation is complete, verification is underway, or the user asks for a final wrap-up.

MageByte-Zero/spec-superflow · 42 tokens

contract-builder

Convert approved planning artifacts into an execution contract. Invoke when the user wants to start building, asks to move from planning to implementation, or when execution-contract.md is missing or stale.

MageByte-Zero/spec-superflow · 39 tokens