Agent skill
doc-component
Document a single component or module interactively. Use when you want to focus on one specific API.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/documents/doc-component
SKILL.md
Document Single Component
Generate or update documentation for a specific source file.
Usage
/doc-component src/components/button.rs
/doc-component Button
Accepts either a file path or a component/type name (will search for it).
Process
- Locate: Find the source file (search if name given)
- Read: Parse the source thoroughly
- Check existing: Read current doc if it exists
- Generate: Write complete documentation following
docsagent style - Output: Write to corresponding location in
docs/
Interactive Mode
If called without arguments, prompt for:
- Component name or path
- Whether to overwrite existing docs or merge
Does NOT Update State
This skill doesn't update docs-state.json since it's for targeted work, not bulk updates. Run /docs afterward if you want to mark the codebase as documented.
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?