documentation-and-adrs

Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning behind a design choice, when changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.

by addyosmani 98k GitHub stars MIT Updated Sep 20, 2026
documentation-and-adrs skill by addyosmani
documentation-and-adrs — Docs skill by addyosmani

Overview

documentation-and-adrs is an open-source docs skill for Claude Code and compatible agents, published by addyosmani. Its author describes it as: “Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning behind a design choice, when changing public APIs, shipping features, or when you need to record conte…”. The project has 98k stars on GitHub and is available under the MIT license. Add it to your setup with `/plugin marketplace add addyosmani/agent-skills`.

What documentation-and-adrs does

Document decisions, not just code. The most valuable documentation captures the *why* — the context, constraints, and trade-offs that led to a decision. Code shows *what* was built; documentation explains *why it was built this way* and *what alternatives were considered*. This context is essential for future humans and agents working in the codebase.

Best for

What’s inside

The SKILL.md for documentation-and-adrs is organised into these sections:

  • Overview
  • When to Use
  • Architecture Decision Records (ADRs)
  • When to Write an ADR
  • Match the existing convention first
  • ADR Template
  • ADR Lifecycle
  • Inline Documentation
  • When to Comment
  • When NOT to Comment
  • Document Known Gotchas
  • API Documentation

Installation

Add documentation-and-adrs to your agent with:

/plugin marketplace add addyosmani/agent-skills

Review a skill’s source before installing it — skills can instruct your agent to run commands. This command comes from the skill’s public repository, which is the source of truth for setup steps. New to skills? Read how to install Claude Code skills.

Supported agents

  • Claude Code — ships a claude code plugin marketplace
  • Codex — declared in the repository topics
  • Cursor — declared in the repository topics
  • Antigravity — declared in the repository topics

License

documentation-and-adrs is published under the MIT license.

Strengths

  • Clear MIT license — safe to read and adapt within its terms
  • Ships in addyosmani/agent-skills, an established project with 97,992 GitHub stars
  • Works with Claude Code, Codex, Cursor, Antigravity
  • Actively maintained — repository updated in the last 30 days
  • Its repository gained 16,916 GitHub stars over the last 52 days

Author

addyosmani 27 skills in the catalog · GitHub profile ↗
View skills

Topics

Alternatives to documentation-and-adrs

Similar skills from other repositories:

Need a skill like this, tailored to your team?Build a custom skill →

Frequently asked questions

What does documentation-and-adrs do?
Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning behind a design choice, when changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.
How do I install documentation-and-adrs?
Run /plugin marketplace add addyosmani/agent-skills in your agent, then reload your skills. Review the source at https://github.com/addyosmani/agent-skills before installing.
Is documentation-and-adrs free to use?
Yes. documentation-and-adrs is free and open source under the MIT license, so you can read, run, and adapt it within that license's terms.
Which agents does documentation-and-adrs work with?
documentation-and-adrs lists Claude Code, Codex, Cursor, and Antigravity — named in its SKILL.md, its plugin marketplace or its repository topics. Skills use the portable SKILL.md format, so other agents that read that format may load it too.
Where does documentation-and-adrs come from?
documentation-and-adrs ships inside addyosmani/agent-skills, a repository that contains 26 catalogued skills in total. The repository's 97,992 GitHub stars apply to that whole collection, not to this skill on its own.

Related skills

More Docs skills →

Grounds every implementation decision in official documentation. Use when you want to verify an approach against the official docs before implementing it, or when you want authoritative, source-cited code free from outdated patterns. Use when building with any framework or library where correctness matters.

↑ GrowingActive Claude CodeCodexCursor+1
98k GitHub stars MIT Updated Sep 20, 2026 Free

Audit and rewrite prose so it stops reading as machine-generated. Use this skill when asked to remove AI-isms, clean up AI writing, edit a draft for AI tells, audit a README, changelog, release note, PR description, or blog post for machine-sounding prose, or make text sound less like AI. Supports a detect-only mode, a rewrite mode, and an edit-in-place mode, with optional voice and context profiles.

Claude CodeCodexCursor+3
39k GitHub stars MIT Updated Aug 24, 2026 Free

Automated Cherry Studio review for local branches, PRs, commits, files, architecture docs, and repository skills. Use for code or documentation reviews that need project-specific naming, main/renderer/shared placement and dependency rules, IpcApi and DataApi boundaries, lifecycle/service ownership, renderer hooks, React/UI conventions, and tests. Review depth adapts to diff size and runtime subagent capability (single-agent or multi-agent reviewer-verifier). Report-only by default; code fixes and GitHub submission each require explicit invocation-time authorization (`fix` / `submit`). Normal-review prompts and safe interruption behavior follow the interaction contract below. To diagnose gaps in the skill after a review session, run `/gh-pr-review diag`.

↑ GrowingActive Claude CodeCodex
52k GitHub stars AGPL-3.0-only Updated Sep 21, 2026 Free

Derive new Office files from structural selections without touching the original. Use when the user points at part of a spreadsheet, Word document, PDF, or PowerPoint deck (a worksheet range, paragraph, page, slide, shape, or a pasted selection-ref block) and wants it extracted, converted, or edited — the result is always a NEW file; the source file is never modified. Covers xlsx range extraction to csv/markdown/xlsx, docx paragraph extraction and text replacement, pdf page extraction, pptx slide/shape/table-cell extraction and editing, and targeted xlsx cell edits.

NewActive Claude CodeCodex
52k GitHub stars AGPL-3.0-only Updated Sep 21, 2026 Free

Rewrite AI-sounding text so it reads like the writer without changing what it says. Use when editing or reviewing prose for AI tells: not-X-but-Y contrasts, one-line closers, staged openers, forced triads, dashes everywhere, inflated claims, sales language, stock AI words, bold labels, or filler. Based on Wikipedia's "Signs of AI writing."

🔥 TrendingActive Claude CodeCodexCursor
51k GitHub stars MIT Updated Sep 6, 2026 Free