Agent skill
Code Documentation Style
Minimal, evergreen code commenting focused on why over what. Use this when adding comments to complex logic, frame calculations, or non-obvious design decisions. Emphasizes self-documenting code through clear naming and structure over excessive comments.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/spekka-global-commenting
SKILL.md
Code Documentation Style
This Skill provides Claude Code with specific guidance on how it should handle global commenting.
When to use this skill:
- Documenting complex animation timing calculations
- Explaining non-obvious frame-based logic
- Adding context for architectural decisions
- Documenting tricky Remotion or S3 edge cases
- Clarifying business rules in validation logic
- Adding JSDoc for public function interfaces
Instructions
- Self-Documenting Code: Write code that explains itself through clear structure and naming
- Minimal, helpful comments: Add concise, minimal comments to explain large sections of code logic.
- Don't comment changes or fixes: Do not leave code comments that speak to recent or temporary changes or fixes. Comments should be evergreen informational texts that are relevant far into the future.
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?