documentation

Writes docstrings, READMEs, and API documentation following Google style conventions.

Updated Sep 2, 2026
One-click install
npx skills add https://github.com/Dazlarus/karl-code --skill documentation-dazlarus
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/Dazlarus/karl-code/tree/main/.agents/skills/documentation
Command: npx skills add https://github.com/Dazlarus/karl-code --skill documentation-dazlarus

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Codebases often ship without docstrings, READMEs, or API references, leaving new contributors and users unable to understand how functions, classes, and modules behave. This Skill provides a structured, standards-based approach to writing and maintaining project documentation. ## Core Features & Use Cases - Docstring Standards: Templates for function, class, and module docstrings in Google style, covering Args, Returns, Raises, and Examples sections. - Project Documentation: Structures for README files, API references, and Sphinx-style documentation with runnable examples. - Maintenance Guidance: Rules for keeping docs in sync with code, including deprecation warnings and a documentation quality checklist. - Use Case: After adding a new public API to a Python package, use this Skill to generate complete Google-style docstrings for every function and update the README quick-start example. ## Quick Start Ask the agent to document a specific module or function, for example: write Google-style docstrings for all public functions in the orders module and update the README.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I write Google-style docstrings in Python?▼

Google-style docstrings use labeled sections: a one-line summary, then Args for parameters, Returns for the return value, Raises for exceptions, and an optional Example. Each section lists items with their type and a short description.

What should a good README file include?▼

A README should contain the project name, a brief description, installation instructions, a quick-start example, a feature list, links to full documentation, and license information. Keep it concise and scannable.

When should I not write documentation for code?▼

Skip documenting private functions, trivial getters and setters, and implementation details obvious from the code itself. Documentation should explain why code exists, not restate what the code already shows.

How do I document a deprecated Python function?▼

Add a deprecation note in the docstring stating the version it was deprecated, the replacement function, and the removal version. Also emit a DeprecationWarning at runtime using the warnings module.

What sections are required in a function docstring?▼

A function docstring requires a one-line summary, an Args section covering all parameters, a Returns section describing the return value and type, and a Raises section listing exceptions. Examples are optional but recommended for non-trivial functions.