documentation-and-adrs SKILL.md skillA

The newest version of a file that held these bytes earlier

documentation-and-adrs in addyosmani/agent-skills is at git:20261101.551c59c (Nov 1, 2026), graded A.

mdr add addyosmani/agent-skills/documentation-and-adrs@git:20261101.551c59c

This copy is 5 versions behind it. See what changed · install this older copy instead

This line moves to the next version by itself within about an hour of that file saving one. A copy already installed stays as it is until you update it.

documentation-and-adrs from vraj-ai/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
vraj-ai/skills
Path
third-party/addyosmani/skills/documentation-and-adrs/SKILL.md
Versions recorded
1
Latest version
git:20261014.242e75d, committed Oct 14, 2026
Size
10,910 bytes
Repository stars
3
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

This older copy, pinned
mdr add vraj-ai/skills/documentation-and-adrs@git:20261014.242e75d

Pins git:20261014.242e75d in mdr.lock, 5 versions behind the newest at the top of this page.

No tool to install first
claude plugin marketplace add https://markdownregistry.com/mp/a/art_k572h2zc65llal2v/b60d503925bbaacee7fd63935db70b9ced5b2514ff5a56a672130e01b9690bc5.json

Then /plugin install documentation-and-adrs@markdownregistry-k572h2zc65llal2v in Claude Code. It installs git:20261014.242e75d, the one graded A here, pinned to the commit it was graded at, and leaves it there.

The exact contents, by fingerprint
mdr add vraj-ai/skills/documentation-and-adrs@sha256:b60d503925bbaace

The older copy line above pins the label git:20261014.242e75d, 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.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_k572h2zc65llal2v.svg)](https://markdownregistry.com/a/art_k572h2zc65llal2v)

2 badge image fetches in 30 days. What the badge shows.

Ask from your agent
claude mcp add --transport http markdownregistry https://markdownregistry.com/mcp/registry

Then ask it: get me the newest addyosmani/agent-skills/documentation-and-adrs, and what changed since b60d503? It reads every saved version here, no key and no account. Any agent that speaks MCP can add it.

Got a copy of documentation-and-adrs from somewhere else? Ask it: where did my documentation-and-adrs come from, and what was changed? It names the public original, the version yours is closest to and every changed line. The text is not kept.

Versions

The registry has recorded 1 version of this file, committed on Oct 14, 2026.

Watch this file (sign in, one email per new version)

versioncommittedcommitsizeaudit
git:20261014.242e75d latest2026-10-14 242e75d 10,910 BA view

Copies

The newest version, then this copy

Newest: git:20261101.551c59c of documentation-and-adrs in addyosmani/agent-skills (skills/documentation-and-adrs/SKILL.md), graded A.

This copy: byte for byte that file's version git:20261008.30f8862, which it committed on Oct 8, 2026, before this repository did; graded A, 5 versions behind.

See what changed since these bytes · ask your agent

Matched on the exact bytes and the commit dates, nothing else. It does not say who wrote the file or where this repository got it.

Keep it current by itself, install once

Committed this skill to a repository? Install the markdownregistry skill updates app on it, or on all of them. When the registry saves a newer version, a pull request brings your copy to it within minutes, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.

Install on GitHub

It asks to read and write contents and pull requests, and to read metadata. No workflow file, no Actions setting, nothing runs on your runners. Uninstall it and everything the registry kept about your repository is deleted.

Keep it current by itself

Committed this skill to a repository? Add one workflow file, and when a newer version is saved, a pull request brings your copy to it, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.

mkdir -p .github/workflows && curl -fsSL https://markdownregistry.com/ci/skill-updates.yml -o .github/workflows/skill-updates.yml

It runs daily on GitHub Actions, no key and no account. Read the workflow before you add it.

Check a whole project

From the root of your project, one line hashes each installed skill's SKILL.md, your AGENTS.md and your CLAUDE.md, and asks the registry once. Only the fingerprints and paths are sent.

sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --data-binary @- https://markdownregistry.com/api/v1/check-copies

In CI, add --fail-with-body: the answer is 409 when any file is behind, so the step fails and still prints which files.

sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --fail-with-body --data-binary @- https://markdownregistry.com/api/v1/check-copies

No sha256sum on your machine? shasum -a 256 prints the same lines.

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (10910 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

GitHub

vraj-ai/skills · 3 stars · license MIT · pushed 2026-11-11 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_k572h2zc65llal2v
GET https://markdownregistry.com/api/v1/resolve?ref=vraj-ai/skills/documentation-and-adrs
GET https://markdownregistry.com/api/v1/blob/b60d503925bbaacee7fd63935db70b9ced5b2514ff5a56a672130e01b9690bc5

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 vraj-ai/skills

verify-skills SKILL.md skill
vraj-ai/skills · .cursor/skills/verify-skills/SKILL.md · Prove the vskills repository by linting every skill's frontmatter and relative cross-references, then running the test…
v1.1.0 · audit A · 3 stars
AGENTS.md AGENTS.md file
vraj-ai/skills · AGENTS.md
git:20261025.fd2cd15 · audit A · 3 stars
land SKILL.md skill
vraj-ai/skills · delivery/land/SKILL.md · Drive open PRs to merged. Re-establish each PR's real state, resolve review threads, conflicts, failing checks, and CI…
v1.7.0 · audit A · 3 stars
ship-record SKILL.md skill
vraj-ai/skills · delivery/ship-record/SKILL.md · Check, attest, and export the ship record every delivery skill shares. Reads the record at $(git rev-parse…
v1.3.0 · audit A · 3 stars
ship SKILL.md skill
vraj-ai/skills · delivery/ship/SKILL.md · Find, pick up, implement, or execute a feature, bug, task, ticket, or ready issue end to end and open a verified…
v4.8.0 · audit A · 3 stars
ai-subscription-unit-economics SKILL.md skill
vraj-ai/skills · pipeline/ai-subscription-unit-economics/SKILL.md · Pricing, limits, and margin gates for a product whose cost of goods is model inference — compute cost per action, cost…
v1.0.0 · audit A · 3 stars
audit SKILL.md skill
vraj-ai/skills · pipeline/audit/SKILL.md · Audit a whole codebase rather than a single diff — establish the boundary and baseline, sweep layer by layer (entry…
v1.0.0 · audit A · 3 stars
delivery-constraints SKILL.md skill
vraj-ai/skills · pipeline/delivery-constraints/SKILL.md · Deliver a ticket whose delivery path is decided by something other than the code — a token/spend cap, a live data…
v1.1.0 · audit A · 3 stars
implementation-tdd SKILL.md skill
vraj-ai/skills · pipeline/implementation-tdd/SKILL.md · Strict one-ticket TDD for implementation work — write the failing test first at the real production seam, lock the…
v1.1.0 · audit A · 3 stars
subagent-delegation SKILL.md skill
vraj-ai/skills · pipeline/subagent-delegation/SKILL.md · Fan work out to subagents safely — delegate independent packages to workers without losing ownership: draw provably…
v1.1.0 · audit A · 3 stars
principle-bounded-repair SKILL.md skill
vraj-ai/skills · principles/principle-bounded-repair/SKILL.md · Bound every repair loop — retrying an identical failure the same way burns budget without generating information. Set a…
v1.0.0 · audit A · 3 stars
principle-evidence-over-report SKILL.md skill
vraj-ai/skills · principles/principle-evidence-over-report/SKILL.md · When a report and the repository disagree — a worker claims success with no commit, a tracker says done but the gate is…
v1.0.0 · audit A · 3 stars

Every file in vraj-ai/skills

Other files named documentation-and-adrs

documentation-and-adrs SKILL.md skill
addyosmani/agent-skills · skills/documentation-and-adrs/SKILL.md · Records decisions and documentation, and detects when documentation has drifted from the code it describes. Use when…
git:20261101.551c59c · audit A · 119,041 stars
documentation-and-adrs SKILL.md skill
shashankswe2020-ux/whoop-mcp · .github/skills/documentation-and-adrs/SKILL.md · Records decisions and documentation. Use when making architectural decisions, changing public APIs, shipping features…
git:20260410.1a22ea0 · audit A · 181 stars
documentation-and-adrs SKILL.md skill
nota-america/forgecat-agent-profiles · profiles/addyosmani/agent-skills/for-claude/.claude/skills/documentation-and-adrs/SKILL.md · Records decisions and documentation. Use when you need to document
git:20260916.3a6b22e · audit A · 93 stars
documentation-and-adrs SKILL.md skill
nota-america/forgecat-agent-profiles · profiles/addyosmani/agent-skills/for-forgecat/platforms/codex/.agents/skills/documentation-and-adrs/SKILL.md · Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning…
git:20260916.3a6b22e · audit A · 93 stars
documentation-and-adrs SKILL.md skill
nota-america/forgecat-agent-profiles · profiles/addyosmani/agent-skills/for-cursor/.cursor/skills/documentation-and-adrs/SKILL.md · Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning…
git:20260916.3a6b22e · audit A · 93 stars
documentation-and-adrs SKILL.md skill
nota-america/forgecat-agent-profiles · profiles/addyosmani/agent-skills/for-forgecat/skills/documentation-and-adrs/SKILL.md · Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning…
git:20260916.3a6b22e · audit A · 93 stars
documentation-and-adrs SKILL.md skill
nota-america/forgecat-agent-profiles · profiles/addyosmani/agent-skills/for-codex/.agents/skills/documentation-and-adrs/SKILL.md · Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning…
git:20260916.3a6b22e · audit A · 93 stars
documentation-and-adrs SKILL.md skill
nota-america/forgecat-agent-profiles · profiles/addyosmani/agent-skills/for-forgecat/platforms/cursor/.cursor/skills/documentation-and-adrs/SKILL.md · Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning…
git:20260916.3a6b22e · audit A · 93 stars

Browse by kind, by grade A, or by owner.