What is an Architecture Decision Record (ADR)?

An ADR is a document that captures a significant technical decision, the context in which it was made, and the consequences (trade-offs) of that choice for the project.

Does it support API documentation for specific languages?

Yes, it includes patterns for JSDoc/TSDoc and standard REST API structures that can be adapted to any programming language or framework.

How does it improve code maintainability?

It enforces the principle of documenting 'why' code exists rather than just 'what' it does, helping future developers understand complex logic and non-obvious workarounds.

What types of documentation can this skill generate?

This skill supports a wide range of formats including project READMEs, REST API references, inline code comments, step-by-step technical guides, and Architecture Decision Records (ADRs).

Technical Documentation Specialist

Name: Technical Documentation Specialist
Author: TheBushidoCollective

byTheBushidoCollective

•

Learning & Documentation

Generates and maintains professional, user-centric technical documentation including READMEs, API references, and architecture records.

About

The Documentation skill empowers Claude to act as a technical writer and documentation architect, ensuring codebases remain accessible and maintainable. It provides structured templates and best practices for creating comprehensive READMEs, detailed REST API documentation, and Architecture Decision Records (ADRs). By focusing on the 'write for the reader' principle, this skill helps developers explain not just what the code does, but why decisions were made, making it an essential tool for open-source projects and professional engineering teams aiming for high-quality project health.

Key Features

Best practice guidelines for meaningful 'Why, not What' inline comments
Standardized README and Technical Guide templates
Architecture Decision Record (ADR) framework for tracking technical rationale
39 GitHub stars
Comprehensive REST API and function documentation patterns
Context-aware documentation generation for users, contributors, and maintainers

Use Cases

Recording the history of architectural choices to provide long-term project context
Documenting complex REST APIs with detailed headers, parameters, and error responses
Onboarding new developers quickly with structured READMEs and quick-start examples

About

Key Features

Best practice guidelines for meaningful 'Why, not What' inline comments
Standardized README and Technical Guide templates
Architecture Decision Record (ADR) framework for tracking technical rationale
39 GitHub stars
Comprehensive REST API and function documentation patterns
Context-aware documentation generation for users, contributors, and maintainers

Use Cases

Recording the history of architectural choices to provide long-term project context
Documenting complex REST APIs with detailed headers, parameters, and error responses
Onboarding new developers quickly with structured READMEs and quick-start examples