Can it help with API documentation?

Absolutely. It provides specific patterns for documenting endpoints, including Pydantic models and OpenAPI metadata for frameworks like FastAPI.

What documentation styles does this skill support?

The skill primarily focuses on Google-style docstrings for Python, which are widely considered the standard for readability and tool compatibility.

How does it handle changelogs?

It follows user-focused principles, grouping changes by type (Added, Fixed, Security) and linking to relevant issues to maintain a clear project history.

Does this skill write inline comments?

Yes, it follows the philosophy of documenting 'why' rather than 'what,' adding context to complex logic or workarounds without restating the code.

What is an ADR and why should I use one?

An Architecture Decision Record (ADR) captures a significant technical decision, its context, and its consequences, helping future maintainers understand why a specific path was chosen.

Professional Code Documentation

Name: Professional Code Documentation
Author: btimothy-har

bybtimothy-har

Learning & Documentation

Generates high-quality, standardized documentation including Google-style docstrings, READMEs, and architecture decision records.

About

This skill empowers developers to maintain professional-grade documentation by enforcing consistent patterns like Google-style Python docstrings and 'why-not-what' inline comments. It streamlines the creation of essential project artifacts such as README files, API endpoint specifications, and Architecture Decision Records (ADRs), ensuring that technical knowledge is captured close to the source and tailored for the right audience. Whether you are documenting a public API or tracking complex architectural trade-offs, this skill ensures your documentation remains useful, current, and accessible.

Key Features

0 GitHub stars
Enforces Google-style Python docstrings for functions, classes, and modules
Creates Architecture Decision Records (ADRs) to track technical trade-offs
Standardizes inline comments and TODO/FIXME formats for better maintainability
Generates structured README files with quick-start and contribution guides
Implements clear API documentation and OpenAPI enhancements using Pydantic

Use Cases

Onboarding new developers by creating structured READMEs and ADRs
Generating comprehensive documentation for a new Python library or API
Refactoring legacy code to include clear explanatory comments and changelogs

About

Key Features

0 GitHub stars
Enforces Google-style Python docstrings for functions, classes, and modules
Creates Architecture Decision Records (ADRs) to track technical trade-offs
Standardizes inline comments and TODO/FIXME formats for better maintainability
Generates structured README files with quick-start and contribution guides
Implements clear API documentation and OpenAPI enhancements using Pydantic

Use Cases

Onboarding new developers by creating structured READMEs and ADRs
Generating comprehensive documentation for a new Python library or API
Refactoring legacy code to include clear explanatory comments and changelogs