What are the recommended documentation coverage targets?

The skill aims for 100% documentation on public APIs, at least 80% for internal functions, and a minimum overall project coverage of 85%.

How does the skill handle complex logic?

It specifically triggers requirements for explanation comments whenever complex logic is detected to ensure maintainability.

What documentation styles does this skill support?

It primarily supports Google Style for Python and JSDoc for JavaScript, ensuring professional and readable docstrings across different languages.

Does this skill help with project README files?

Yes, it provides a standardized 6-point structure for READMEs including installation, usage, API documentation, and contributing guidelines.

When should I apply this skill in my workflow?

Apply this skill whenever you are generating new functions, updating docstrings, or creating project-level documentation to maintain consistency.

Documentation Best Practices

Name: Documentation Best Practices
Author: bejranonda

bybejranonda

•

Learning & Documentation

Generates comprehensive, standardized technical documentation using industry-leading templates and coverage targets.

The Documentation Best Practices skill empowers Claude to produce high-quality technical documentation by enforcing standardized formats such as Google Style Python docstrings and JSDoc. It establishes clear coverage targets for public and internal APIs, ensuring that complex logic is well-explained and project READMEs follow a professional, logical structure. This skill is essential for teams looking to maintain professional documentation standards, improve code maintainability, and streamline the onboarding process for new developers.

Key Features

019 GitHub stars

02JSDoc standard implementation for JavaScript

03Standardized README structure and components

04Google Style Python docstring templates

05Automated guidance for documenting complex logic

06Defined documentation coverage targets (85%+)

Use Cases

01Generating API documentation for new Python or JavaScript libraries

02Standardizing README files across a multi-repository project

03Retroactively improving documentation coverage for legacy codebases

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add bejranonda/llm-autonomous-agent-plugin-for-claude documentation-best-practices

For use in Claude.ai and ChatGPT

Download Skill

Key Features

019 GitHub stars

02JSDoc standard implementation for JavaScript

03Standardized README structure and components

04Google Style Python docstring templates

05Automated guidance for documenting complex logic

06Defined documentation coverage targets (85%+)

Use Cases

01Generating API documentation for new Python or JavaScript libraries

02Standardizing README files across a multi-repository project

03Retroactively improving documentation coverage for legacy codebases

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add bejranonda/llm-autonomous-agent-plugin-for-claude documentation-best-practices

For use in Claude.ai and ChatGPT

Download Skill