writing-code-documentation
CommunityEnforce and implement high-quality code documentation conventions.
Software Engineering#development workflow#standardization#software quality#APIs#guidelines#code documentation
AuthorMrHadiSatrio
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Ensures consistent and informative documentation for public APIs, reducing confusion and increasing maintainability of the codebase.
Core Features & Use Cases
- Documentation Standards: Implements a clear, concise framework for documenting code, adhering to industry best practices.
- API Documentation: Automates the generation of documentation for public APIs, providing immediate benefits in maintainability.
- Guidelines and Examples: Offers examples of good and bad practices, ensuring a strong foundation in code documentation skills.
- Integration with Codebases: Can be integrated into development workflows to ensure consistent documentation across all projects.
Quick Start
To document a new function in your project, create a comment above it and use the provided format for function descriptions.
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: writing-code-documentation Download link: https://github.com/MrHadiSatrio/Skills/archive/main.zip#writing-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 620,000+ vetted skills library on demand.