code-quality-docs
CommunityImprove code clarity and traceability.
Authorpkuppens
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill addresses the challenge of maintaining high code quality by enforcing clear documentation and comment standards, ensuring that code explains its purpose and technical debt is traceable.
Core Features & Use Cases
- Enforces Documentation Standards: Guides the creation of comprehensive docstrings for functions, including arguments, return values, and exceptions.
- Promotes Meaningful Comments: Discourages redundant comments and emphasizes explanations for non-obvious design decisions.
- Manages Technical Debt: Standardizes the way TODO comments are written, encouraging task references or detailed, actionable descriptions.
- Use Case: When writing a new Python function, use this Skill to ensure you add a clear docstring explaining its purpose, parameters, and any potential exceptions, and add a traceable TODO comment for any known limitations.
Quick Start
Apply comment and documentation standards for Python code.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: code-quality-docs Download link: https://github.com/pkuppens/on_prem_rag/archive/main.zip#code-quality-docs Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.