docs
SKILL.md
Check that all code has appropriate documentation.
Arguments: $ARGUMENTS (optional scope)
- commit: Check only staged files
- pr: Check all files changed in the current PR
- all: Check the entire codebase
- If no argument provided:
- If in a PR branch: defaults to 'pr'
- Otherwise: defaults to 'commit'
Phase 1: Scope Determination
- Determine scope based on $ARGUMENTS
Phase 2: Documentation Analysis
- Identify functions/classes lacking documentation
- Check quality of existing documentation
- Extract project documentation standards from CLAUDE.md
Phase 3: Documentation Updates
-
For identified gaps:
- Generate documentation following project conventions
- Apply language-specific formats (roxygen2, docstrings, JSDoc)
- Use
@inheritParamsin R to avoid duplication
-
For R projects: Run
devtools::document()to update man/ files
Phase 4: Quality Verification
- Verify documentation format compliance and no broken references
Phase 5: Report Results
- Summary of files checked, documentation added/updated, and remaining issues
Auto-Exit When Standalone
IMPORTANT: If this command is being run as a standalone request, automatically exit after completing all phases successfully.
Weekly Installs
4
Repository
seabbs/claude-c…e-configGitHub Stars
6
First Seen
Feb 10, 2026
Security Audits
Installed on
amp4
github-copilot4
codex4
kimi-cli4
gemini-cli4
opencode4