跳到正文
TakoAPI
返回技能列表

docsync

由 suhteevah 提供

PDF & Documents
536下载量由 clawskills.sh 提供
0浏览量
0 个赞登录后即可为这个技能点赞
—暂无评分
你的评分

简介

Auto-generate docs from code and detect documentation drift via git hooks.

描述

该技能的功能

DocSync generates documentation from source code using tree-sitter for AST parsing across 11 languages. It detects documentation drift, finding where code changed but docs were not updated, and can install git hooks to enforce updates on every commit. Free tier covers one-shot doc generation; Pro and Team tiers add drift detection, auto-fix, onboarding guides, and architecture docs.

All parsing and license validation happen locally with no network calls, so it works in air-gapped environments and never sends source code to external servers.

何时使用

  • Generating a README after writing a new TypeScript library
  • Checking if API docs are stale after a refactor
  • Blocking commits when critical documentation is missing
  • Creating an onboarding guide for engineers joining a large codebase
  • Finding undocumented functions added over the past sprint

示例工作流

输入

User asks: Check if my docs are up to date in the src/ directory

智能体
  1. 1

    Validates Pro license key from config

  2. 2

    Parses all source files in src/ with tree-sitter to extract symbols, signatures, and exports

  3. 3

    Compares extracted symbols against existing documentation files

  4. 4

    Identifies new undocumented symbols, changed signatures with stale docs, and deleted symbols still referenced in docs

  5. 5

    Outputs a drift report with severity levels: critical, warning, and info

输出

Drift report listing every out-of-sync documentation item by file, symbol, and severity level

前置要求

  • DOCSYNC_LICENSE_KEY environment variable
  • Paid license from docsync.pages.dev (Pro: $29/user/month, Team: $49/user/month) — required for drift detection, hooks, auto-fix, onboarding, and architecture commands

安装

clawhub install suhteevah/docsync

运行 CLI 命令,或把这段提示词粘贴到 Claude Code、Cursor、Codex 或你在用的任意编程智能体里。

链接