Can it help with API documentation?

Yes, it provides a specific pattern for documenting endpoints including method, path, parameters, request examples, and response/error codes.

How does it organize project documentation files?

It establishes a standardized /docs directory structure, separating API references, architecture records, and getting-started guides into a navigable hierarchy.

Does it manage the ADR lifecycle?

Yes, it tracks decision statuses from Proposed and Accepted to Deprecated or Superseded, maintaining a central index at docs/adr/README.md.

Which documentation standards does this skill support?

It implements the MADR (Markdown Any Decision Record) format for architecture, 'Keep a Changelog' for versioning, and Semantic Versioning (SemVer) for release management.

Markdown Documentation Patterns

Name: Markdown Documentation Patterns
Author: jsamuelsen11

byjsamuelsen11

0•

Learning & Documentation

Standardizes project documentation through automated README structures, Architecture Decision Records (ADRs), and Keep a Changelog formatting.

The Markdown Documentation Patterns skill provides Claude with a comprehensive framework for architecting professional project documentation. It enforces industry best practices by providing structured templates for READMEs, managing Architecture Decision Records (ADRs) using the MADR format, and maintaining changelogs following 'Keep a Changelog' standards. This skill is essential for developers looking to maintain consistent, navigable, and high-quality documentation across complex software repositories, ensuring that API references, file organization, and decision history remain synchronized and accessible.

Key Features

01Standardized README templates with logical section ordering and badge placement

02Structured API documentation patterns including endpoints, params, and examples

03Changelog management following Keep a Changelog and Semantic Versioning

04Automated documentation directory layout and index maintenance

050 GitHub stars

06MADR-compliant Architecture Decision Records (ADRs) with status tracking

Use Cases

01Generating structured API reference guides with runnable code examples

02Bootstrapping a new software repository with professional-grade documentation

03Recording and indexing complex architectural decisions for team alignment

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jsamuelsen11/claude-config documentation-patterns

For use in Claude.ai and ChatGPT

Download Skill