Can it help with API documentation?

Yes, it includes specialized templates for API references, REST endpoints, request/response examples, and OpenAPI annotations.

Does it maintain existing project styles?

Yes, the skill is designed to detect existing documentation patterns in your project and match the established tense, format, and conventions.

How does it ensure documentation accuracy?

The skill follows a 'code as source of truth' principle, encouraging the verification of behavior against the actual source code and marking uncertain items with TODO tags for manual review.

Which docstring formats does this skill support?

It supports a wide range of formats including Google-style, NumPy, Sphinx (reStructuredText) for Python, JSDoc/TSDoc for JavaScript/TypeScript, godoc for Go, and rustdoc for Rust.

Documentation Patterns

Name: Documentation Patterns
Author: AnExiledDev

byAnExiledDev

•

Learning & Documentation

Generates structured, audience-specific technical documentation including READMEs, API references, and standardized docstrings.

Documentation Patterns is a specialized skill for Claude Code designed to streamline the creation of high-quality technical documentation. It provides standardized templates and logic for various audiences, ensuring that READMEs, architecture docs, and inline docstrings are accurate, concise, and professional. By enforcing the principle that code is the source of truth, this skill helps developers maintain documentation that is synchronized with their codebase while supporting multiple industry-standard formats like Google-style docstrings, Sphinx, JSDoc, and Rustdoc.

Key Features

016 GitHub stars

02AI-optimized document sizing rules to ensure readability for both humans and LLMs

03Multi-language docstring support for Python, JavaScript, Go, and Rust

04Standardized README scaffolding based on a five-question clarity framework

05Audience-specific formatting logic for users, integrators, and maintainers

06Automated verification of installation commands, file paths, and parameters

Use Cases

01Generating professional README files for new open-source repositories

02Creating technical architecture documents that explain the 'why' behind system design

03Adding comprehensive JSDoc or Google-style docstrings to existing legacy code

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add anexileddev/codeforge documentation-patterns

For use in Claude.ai and ChatGPT

Download Skill