Agent skill
refactoring-07-documentation-usage
Use when documenting Python research code usage, setup, and experiment reproduction.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/development/refactoring-07-documentation-usage
SKILL.md
Refactoring 07: Documentation and Usage
Goal
Make the project understandable and runnable by a new contributor.
Sequence
- Order: 07
- Previous: refactoring-06-static-analysis-style
- Next: refactoring-08-experiment-tracking
Workflow
- Update
README.mdwith purpose, setup, data expectations, and run commands.- Success: README includes accurate setup and run instructions.
- Add docstrings for public modules and functions that are reused.
- Success: Public APIs have concise docstrings.
- Provide a minimal example command or notebook that reproduces results.
- Success: A minimal example reproduces expected output.
- Document output artifacts and how to interpret them.
- Success: Outputs and metrics are explained in docs.
- Keep docs synced with the current entrypoints and config fields.
- Success: Docs match current entrypoints and config options.
Guardrails
- Avoid duplicating API docs already generated elsewhere.
- Keep examples small and fast to run.
- Prefer concrete commands over narrative text.
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
majiayu000/claude-skill-registry
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.
majiayu000/claude-skill-registry
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.
majiayu000/claude-skill-registry
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.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
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?