skills.rest
bejranonda
bejranondaCOMMUNITY
Explore all skills by this author →
GitHub

documentation-best-practices

Generate Google-style Python and JSDoc documentation templates with coverage targets.

27|16|Updated Oct 20, 2025
Search Tags:#best practices#documentation#technical writing#docstrings#API docs#README#knowledge sharing
One-click install
npx skills add https://github.com/bejranonda/LLM-Autonomous-Agent-Plugin-for-Claude --skill documentation-best-practices
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-best-practices
Source: https://github.com/bejranonda/LLM-Autonomous-Agent-Plugin-for-Claude/tree/main/skills/documentation-best-practices
Command: npx skills add https://github.com/bejranonda/LLM-Autonomous-Agent-Plugin-for-Claude --skill documentation-best-practices

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about documentation-best-practices

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write effective docstrings for Python functions?▼

Python docstrings should follow Google Style format, documenting parameters, return values, and exceptions. This Skill provides standardized Google-style templates that ensure consistent, informative function documentation across your codebase.

What should a README file include?▼

A README should contain project title, installation instructions, usage examples, and API documentation. This Skill outlines a standard README structure to communicate your project's purpose and guide users through setup and functionality.

How much documentation coverage do I need for my codebase?▼

Documentation coverage targets are 100% for public APIs, 80% or more for internal functions, and explicit explanations for complex logic. This Skill defines these benchmarks and provides templates to meet them systematically.

Can I use documentation templates for JavaScript code?▼

Yes. This Skill provides JSDoc templates for JavaScript alongside Python Google-style docstrings, enabling consistent technical documentation across multiple languages in the same project.

Why is standardized documentation important for teams?▼

Standardized documentation reduces manual effort, improves clarity, and enables knowledge sharing across teams. This Skill ensures consistency in docstrings, API docs, and READMEs, making codebases easier to maintain and understand.

Related Skills

Explore More Content & Communication Skills→
youdotcom-ossyoudotcom-oss
5

code-documentation

Generate and maintain TSDoc comments for TypeScript and JavaScript codebases.

Official
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
VoDaiLoczVoDaiLocz
24

lint-and-validate

Automate linting and static analysis of code in CI pipelines.

Community
Intermediate
mvillmowmvillmow
18

generate-docstrings

Generate structured docstrings for functions and classes in Google, NumPy, and reStructuredText formats.

Community
Basic