本文へ移動
cccskills
無料GitHub で公開

docs-review

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

インストール方法を見る

含まれるファイル(1)

  • SKILL.md2.0 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

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

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

archeo

無料

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.

日本語の概要は準備中です。原文の説明を表示しています。

jamie8johnson/cqs172026年7月14日 更新

audit

無料

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

日本語の概要は準備中です。原文の説明を表示しています。

jamie8johnson/cqs172026年7月14日 更新

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

日本語の概要は準備中です。原文の説明を表示しています。

jamie8johnson/cqs172026年7月14日 更新

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.

日本語の概要は準備中です。原文の説明を表示しています。

jamie8johnson/cqs172026年7月14日 更新

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

日本語の概要は準備中です。原文の説明を表示しています。

jamie8johnson/cqs172026年7月14日 更新

cqs

無料

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.

日本語の概要は準備中です。原文の説明を表示しています。

jamie8johnson/cqs172026年7月14日 更新

jamie8johnson のスキルをすべて見る

このスキルの問題を報告する