code-documentation
CommunityStandardize code docs for clarity and consistency
Software Engineering#documentation#docstrings#best-practices#code-comments#architecture-docs#READMEs
AuthorJonathan0823
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Developers often grapple with inconsistent code documentation across projects, creating onboarding friction and maintenance challenges. This skill provides structured guidelines, templates, and best practices to unify inline comments, docstrings, and README content.
Core Features & Use Cases
- Frontmatter-driven metadata: Ensures every document includes a name and description header for consistent discovery and indexing.
- Multi-language documentation patterns: Guides for Go, Python, TypeScript, and Rust docstrings, function/method docs, and architecture docs.
- Template-driven artifacts: Ready-to-use README templates, API docs sections, and architecture decision patterns to accelerate documentation and onboarding.
Quick Start
Use this skill to establish a unified documentation standard across a codebase by adding a SKILL.md with a name and description and applying the prescribed layouts to comments, docstrings, and READMEs.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 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-documentation Download link: https://github.com/Jonathan0823/opencode-config/archive/main.zip#code-documentation 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.