Skip to content
cccskills
FreePublished on GitHub

docs-review

Review project docs for staleness. Checks lib.rs, Cargo.toml, README, CONTRIBUTING, SECURITY, PRIVACY, and GitHub repo metadata.

The English summary is being prepared. Showing the original description.

Works withGitHub
See how to install

Files included (1)

  • SKILL.md2.0 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

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.mdSkills list matches .claude/skills/; Project Conventions accurate (MSRV, feature names); WSL/CI guidance not contradicting current practice
    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

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

archeo

Free

Comment-archaeology sweep - find work items hiding in TODO/FIXME/for-now comments and plan-doc ledgers, judge them, file issues, queue trivial fixes. Good idle-loop activity.

The English summary is being prepared. Showing the original description.

jamie8johnson/cqs17Updated Jul 14, 2026

audit

Free

Run a multi-category code audit on the cqs codebase. Spawns parallel agents per batch.

The English summary is being prepared. Showing the original description.

jamie8johnson/cqs17Updated Jul 14, 2026

Run before modifying a function — impact + test-map + explain in one pass, presented as a modification checklist.

The English summary is being prepared. Showing the original description.

jamie8johnson/cqs17Updated Jul 14, 2026

Trust-boundary security audit of cqs — fans out unbiddable-auditor agents across 6 categories (RT-INJ/RT-FS/RT-RES/RT-DATA/RT-RELAY/RT-EXFIL), attacker mindset, run-the-attack PoC + regression guard.

The English summary is being prepared. Showing the original description.

jamie8johnson/cqs17Updated Jul 14, 2026

Run after making changes, before committing — reviews the current git diff for impact and risk via cqs review.

The English summary is being prepared. Showing the original description.

jamie8johnson/cqs17Updated Jul 14, 2026

cqs

Free

Unified cqs CLI dispatcher — semantic code search, call graph navigation, impact analysis, quality tools, notes, and infrastructure. Use `/cqs <command> [args]` for any cqs operation.

The English summary is being prepared. Showing the original description.

jamie8johnson/cqs17Updated Jul 14, 2026

See all skills by jamie8johnson

Report a problem with this skill