AgentSkillsCN

docs-review

定期审查项目文档的时效性——检查 lib.rs、Cargo.toml、README、CONTRIBUTING、SECURITY、PRIVACY，以及 GitHub 仓库的元数据。

SKILL.md
--- frontmatter
name: docs-review
description: Review project docs for staleness. Checks lib.rs, Cargo.toml, README, CONTRIBUTING, SECURITY, PRIVACY, and GitHub repo metadata.
disable-model-invocation: false

Docs Review

Check all project documentation for staleness and fix what's drifted.

Process

  1. •

    Scope the review:

    • •Run git log vLAST_TAG..HEAD --stat to see what changed since last release
    • •Focus on docs affected by those changes
    • •If no tag exists, review everything
  2. •

    Check each item:

    FileWhat to check
    src/lib.rs doc commentLanguage count, feature list, API examples compile, Quick Start accuracy
    Cargo.tomldescription (crates.io one-liner), keywords, categories
    README.mdHardcoded versions (schema, install), feature list, usage examples, badge URLs
    CONTRIBUTING.mdArchitecture Overview matches current file layout — any files added/moved/renamed?
    SECURITY.mdThreat model current, dependency notes, any new attack surfaces?
    PRIVACY.mdData handling claims still accurate?
    CLAUDE.mdQuick Reference (version, schema, test count, language count)
    GitHub repoDescription and topics — gh repo view, update with gh repo edit if needed
  3. •

    Fix and report:

    • •Fix stale docs directly
    • •Report what was updated and what was already current
    • •If unsure about a claim, flag it rather than guessing

When to run

  • •Before releases (/release references this)
  • •After significant feature PRs
  • •Before audits
  • •When you suspect drift

Rules

  • •Don't rewrite docs for style — only fix factual staleness
  • •Don't add content — only correct what exists
  • •Check numbers against code: grep for hardcoded counts (languages, tests, dimensions) and verify
  • •If CONTRIBUTING.md Architecture Overview lists files, glob to confirm they exist