documentation-and-adrs SKILL.md skillA
documentation-and-adrs from addyosmani/agent-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add addyosmani/agent-skills/documentation-and-adrs@git:20261019.8e6726dPins git:20261019.8e6726d in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- addyosmani/agent-skills
- Path
skills/documentation-and-adrs/SKILL.md- Versions recorded
- 9
- Latest version
- git:20261019.8e6726d, committed Oct 19, 2026
- First version recorded
- Mar 31, 2026
- Size
- 10,999 bytes
- Repository stars
- 112,362
- License
- MIT
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.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# Documentation and ADRs ## Overview 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. ## When to Use - Making a significant architectural decision - Choosing between competing approaches - Adding or changing a public API - Shipping a feature that changes user-facing behavior - Onboarding new team members (or agents) to the project - When you find yourself explaining the same thing repeatedly **When NOT to use:** Don't document obvious code. Don't add comments that restate what the code already says. Don't write docs for throwaway prototypes. ## Architecture Decision Records (ADRs) ADRs capture the reasoning behind significant technical decisions. They're the highest-value documentation you can write. ### When to Write an ADR - Choosing a framework, library, or major dependency - Designing a data model or database schema - Selecting an authentication strategy …
Read the whole file at its exact version.
How to install
mdr add addyosmani/agent-skills/documentation-and-adrs@sha256:6fccf3088d5042a3The line at the top of this page pins the label git:20261019.8e6726d, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_y32faly2zrmxn4z2)
5 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 9 versions of this file, between Mar 31, 2026 and Oct 19, 2026, about one every 25 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261019.8e6726d latest | 2026-10-19 | 8e6726d | 10,999 B | A | view · diff |
| git:20261008.30f8862 | 2026-10-08 | 30f8862 | 10,910 B | A | view · diff |
| git:20261007.fe9f1f2 | 2026-10-07 | fe9f1f2 | 11,416 B | A | view · diff |
| git:20260926.546bd84 | 2026-09-26 | 546bd84 | 9,859 B | A | view · diff |
| git:20260907.cda4542 | 2026-09-07 | cda4542 | 9,848 B | A | view · diff |
| git:20260716.a0eba71 | 2026-07-16 | a0eba71 | 9,782 B | A | view · diff |
| git:20260714.0d52faf | 2026-07-14 | 0d52faf | 9,663 B | A | view · diff |
| git:20260331.fea75b1 | 2026-03-31 | fea75b1 | 8,734 B | A | view · diff |
| git:20260331.702a894 | 2026-03-31 | 702a894 | 8,697 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (10999 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
addyosmani/agent-skills · 112,362 stars · license MIT · pushed 2026-10-31 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_y32faly2zrmxn4z2 GET https://markdownregistry.com/api/v1/resolve?ref=addyosmani/agent-skills/documentation-and-adrs GET https://markdownregistry.com/api/v1/blob/6fccf3088d5042a3c889faa25113ffa47b9f7f999f4fc9e527d5e5226888442f
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from addyosmani/agent-skills
Every file in addyosmani/agent-skills