documentation-best-practices
CommunityGenerate clear docs, boost understanding, save time.
Content & Communication#best practices#documentation#technical writing#docstrings#API docs#README#knowledge sharing
Authorbejranonda
Version1.0.0
Installs0
System Documentation
What problem does it solve? This Skill guides the creation of high-quality, comprehensive technical documentation, including docstrings, API documentation, and README files. It ensures clarity and consistency across projects, reducing the effort in manual documentation and improving knowledge sharing.
Core Features & Use Cases:
- Documentation Coverage Targets: Defines recommended coverage percentages for public APIs, internal functions, and complex logic.
- Docstring Templates: Provides structured templates for Python (Google Style) and JavaScript (JSDoc) to ensure consistent and informative function documentation.
- README Structure: Outlines a standard structure for README files, covering project title, installation, usage, and API documentation.
- Use Case: When a new Python function is created, this skill automatically generates a Google-style docstring template, prompting for parameters, returns, and potential raises, ensuring immediate and consistent documentation.
Quick Start: Explain the "Documentation Coverage Targets" and provide the "Python (Google Style)" docstring template.
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: documentation-best-practices Download link: https://github.com/bejranonda/LLM-Autonomous-Agent-Plugin-for-Claude/archive/main.zip#documentation-best-practices Please download this .zip file, extract it, and install it in the .claude/skills/ directory.