doc-debt
Surface documentation debt — stale READMEs, missing public API docs, broken internal links, undocumented env vars. Use when onboarding gets friction, before a release, or when an API has evolved without matching doc updates.
What this skill does
# Doc Debt Surface documentation that no longer matches reality, and public surfaces that were never documented. ## Philosophy > "What would a new contributor misunderstand from our docs?" Docs rot quietly. A version number that drifted from the manifest, a link to a wiki that was retired, a function parameter added to the code but never to the docs — each is small, but together they tell new contributors the project doesn't take its own documentation seriously. Not a linter. The value is spotting *divergence between docs and code*, not formatting. ## Scope User may specify a file path, glob, or directory. If not specified, ask: *"Which directory should I audit? (A README or a `docs/` folder is typical.)"* ## Config Integration Follow `references/config-migration.md` for preflight. Read `.assistant-config.md` for: - **Docs location** (set by `/teach-charter`) - **Acknowledged Debt** entries for this dimension - **Stack** (determines which manifest to cross-reference for version drift) ## Stack Detection Glob for manifest files to find the canonical version number: - `package.json` — the `version` field - `pyproject.toml` — `[project] version` - `Gemfile` / `Gemfile.lock` - `go.mod` - `Cargo.toml` — `[package] version` Use this for version-drift checks. ## Process ### 1. Understand context Read the project's main README. Identify declared version, install commands, usage examples, linked resources. Note what the README claims is true. ### 2. Scan For each signal in `references/doc-debt-checklist.md`: - **Version drift:** compare versions in docs vs. manifest. - **Broken internal links:** Glob for markdown files, Grep for `](./` and `](../`, verify targets exist. - **Missing public API docs:** Grep for exported symbols in source, cross-reference against README/docs. - **Undocumented env vars:** Grep for `process.env`, `os.environ`, `ENV[` in source, cross-reference against docs. - **Stale dates:** Grep for year patterns (`20\d\d`) in changelogs and release notes. ### 3. Group by location Organize by document (README, docs/api.md, etc.) or by source module where the gap lives. ### 4. Assess impact - **High:** affects onboarding (install, quickstart, first-run docs) - **Medium:** affects day-to-day usage (API reference, examples) - **Low:** internal notes, archived sections ## Reference - `references/doc-debt-checklist.md` - `references/debt-output-format.md` - `references/config-migration.md` ## Output format Follow `references/debt-output-format.md` exactly. ## What Makes This Different From a Linter Linters check formatting. This skill checks *fidelity*: - Is the version in the README the version we actually ship? - Does the function signature in the docs match the function in the code? - Do the links go anywhere? A doc with perfect markdown formatting and wrong facts is worse than a doc with imperfect formatting and right facts. This skill surfaces the former.
Related in Backend & APIs
jfrog
IncludedInteract with the JFrog Platform via the JFrog CLI and REST/GraphQL APIs. Use this skill when the user wants to manage Artifactory repositories, upload or download artifacts, manage builds, configure permissions, manage users and groups, work with access tokens, configure JFrog CLI servers, search artifacts, manage properties, set up replication, manage JFrog Projects, run security audits or scans, look up CVE details, query exposures scan results from JFrog Advanced Security, manage release bundles and lifecycle operations, aggregate or export platform data, or perform any JFrog Platform administration task. Also use when the user mentions jf, jfrog, artifactory, xray, distribution, evidence, apptrust, onemodel, graphql, workers, mission control, curation, advanced security, exposures, or any JFrog product name.
cupynumeric-migration-readiness
IncludedPre-migration readiness assessor for porting NumPy to cuPyNumeric. Use BEFORE substantial porting work begins when the user asks whether code will scale on GPU, whether they should migrate to cuPyNumeric, which NumPy patterns transfer cleanly, what must be refactored before porting, or mentions pre-port assessment, scaling analysis, or refactor planning. Inspect the user's source code, look up NumPy usage, cross-reference the cuPyNumeric API support manifest, and distinguish distributed-scaling-friendly patterns from blockers such as unsupported APIs, scalar synchronization, host round-trips, Python/object-heavy control flow, shape/data-dependent branching, and in-place mutation hazards. Produce a verdict of READY, LIGHT REFACTOR, SIGNIFICANT REFACTOR, or NOT RECOMMENDED, with concrete refactor pointers.
alibabacloud-data-agent-skill
IncludedInvoke Alibaba Cloud Apsara Data Agent for Analytics via CLI to perform natural language-driven data analysis on enterprise databases. Data Agent for Analytics is an intelligent data analysis agent developed by Alibaba Cloud Database team for enterprise users. It automatically completes requirement analysis, data understanding, analysis insights, and report generation based on natural language descriptions. This tool supports: discovering data resources (instances/databases/tables) managed in DMS, initiating query or deep analysis sessions, real-time progress tracking, and retrieving analysis conclusions and generated reports. Use this Skill when users need to query databases, analyze data trends, generate data reports, ask questions in natural language, or mention "Data Agent", "data analysis", "database query", "SQL analysis", "data insights".
token-optimizer
IncludedReduce OpenClaw token usage and API costs through smart model routing, heartbeat optimization, budget tracking, and native 2026.2.15 features (session pruning, bootstrap size limits, cache TTL alignment). Use when token costs are high, API rate limits are being hit, or hosting multiple agents at scale. The 4 executable scripts (context_optimizer, model_router, heartbeat_optimizer, token_tracker) are local-only — no network requests, no subprocess calls, no system modifications. Reference files (PROVIDERS.md, config-patches.json) document optional multi-provider strategies that require external API keys and network access if you choose to use them. See SECURITY.md for full breakdown.
resend-cli
IncludedUse this skill when the task is specifically about operating Resend from an AI agent, terminal session, or CI job via the official resend CLI: installing/authenticating the CLI, sending/listing/updating/cancelling emails, batch sends, domains and DNS, webhooks and local listeners, inbound receiving, contacts, topics, segments, broadcasts, templates, API keys, profiles, or debugging Resend CLI/API failures. Trigger on mentions of Resend CLI, `resend`, `resend doctor`, `resend emails send`, `resend domains`, `resend webhooks listen`, `resend emails receiving`, or agent-friendly terminal automation.
alibabacloud-odps-maxframe-coding
IncludedUse this skill for MaxFrame SDK development and documentation navigation on Alibaba Cloud MaxCompute (ODPS). Helps answer MaxFrame API, concept, official example, and supported pandas API questions; create data processing programs; read/write MaxCompute tables; debug jobs (remote or local); and build custom DPE runtime images. Trigger when users mention MaxFrame, MaxCompute with MaxFrame, ODPS table processing, DPE runtime, MaxFrame docs/examples, DataFrame/Tensor operations, or GPU runtime setup. Works for both English and Chinese queries about Alibaba Cloud data processing with MaxFrame.