documentation-patterns

Standardize project documentation with ADR templates and Google-style docstrings.

3|Updated Feb 15, 2026

Search Tags:#changelog #documentation #technical writing #adr #code comments #api documentation

Ready to run

npx skills add https://github.com/pvliesdonk/agents.md --skill documentation-patterns-pvliesdonk

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-patterns
Source: https://github.com/pvliesdonk/agents.md/tree/main/skills/documentation-patterns
Command: npx skills add https://github.com/pvliesdonk/agents.md --skill documentation-patterns-pvliesdonk

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses inconsistencies in project documentation, API standards, and technical writing by providing clear guidelines and templates for Architecture Decision Records (ADRs), docstrings, changelogs, and code comments.

Core Features & Use Cases

ADR Management: Standardized template and lifecycle for capturing architectural decisions.
API Documentation: Enforces Google-style docstrings and type hints for clarity.
Writing Voice: Promotes precision, conciseness, and active voice in technical communication.
Changelog Generation: Leverages Conventional Commits for automated release notes.
Use Case: Ensure all new architectural decisions are properly documented in ADRs, and that all public Python functions have clear, informative docstrings following a consistent standard.

Quick Start

Use the documentation-patterns skill to generate a new ADR using the MADR template.

Frequently Asked Questions about documentation-patterns

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

FAQPage Schema

What is an Architecture Decision Record and when should I use one?▼

An Architecture Decision Record (ADR) captures important architectural decisions and their context. You should use an ADR template whenever your team makes a significant structural choice to ensure consistency and clarity across the project.

How do I write Google-style docstrings for API documentation?▼

To write Google-style docstrings for API documentation, use defined templates that enforce type hints and clear descriptions. This ensures public functions have informative, standardized technical communication.

What's the best way to generate a changelog from Conventional Commits?▼

The best way to generate a changelog from Conventional Commits is to leverage standardized changelog patterns. This approach automates release notes by mapping commit message conventions directly to documentation entries.

How do I standardize code comments and technical writing across a development team?▼

To standardize code comments and technical writing, apply guidelines that promote precision, conciseness, and active voice. These defined practices ensure consistent communication across the entire development team.

Does this documentation standardization approach work without external dependencies?▼

Yes, this documentation standardization approach works without external dependencies. It provides defined templates and guidelines for technical writing, ADRs, and changelogs directly through its internal references.