Home / jpeetz / agent-skills · skills/documentation-content/documentation-and-adrs/SKILL.md · GitHub

documentation-and-adrs skillA

documentation-and-adrs is agent-read markdown (skill) from jpeetz/agent-skills: Use this skill when you need to record an architecture decision (ADR) or document the reasoning behind a design choice — when changing public APIs, shipping features that change behavior, or recording context that future engineers (human or agent) will need to understand the codebase. Does NOT replace code comments or inline docstrings; targets strategic documentation and decision capture. Primary keywords: ADR architecture decision record, technical documentation, design rationale, decision log.

Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.

What the file says

# Documentation and ADRs

Records decisions and documents the *why* — context, constraints, trade-offs, and rejected alternatives that code alone cannot express.

---

## Overview

Code tells you *what* was built. Documentation tells you *why* it was built that way, *what alternatives were rejected*, and *what constraints governed the decision*. The most valuable documentation captures the reasoning, not the mechanics.

This skill covers four documentation layers, from most to least strategic:

| Layer | What | When | Effort |
|-------|------|------|--------|
| **🏛️ ADRs** | Architecture Decision Records — capture *why* a decision was made | Every significant architectural choice | 10-30 min |
| **📘 README** | Project entry point — what, why, how | New projects, major releases | 15-60 min |
| **🔌 API Docs** | Endpoint/schema documentation | Every public API change | Per-endpoint |
| **📝 Inline Docs** | Comments explaining *why*, not *what* | Continuously | Seconds |

**Core principle: document decisions, not mechanics.** A comment explaining *why* a rate limit uses a sliding window is valuable. A comment that says `// Increment counter by 1` above `counter += 1` is noise.

---
…

Read the whole file at its exact version.

How to install

Latest version
mdr add jpeetz/agent-skills/documentation-and-adrs@v1.0.0
Exact content
mdr add jpeetz/agent-skills/documentation-and-adrs@sha256:dfea4a4c21ff1292

Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.

Badge

mdr badge

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

1 badge views in 30 days

Versions

versioncommittedcommitsizeaudit
v1.0.0 latest2026-09-21 3f0e3da 12,310 BA view

Audit of the latest version

A  17 of 17 checks passed. Deterministic, no model, 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 (12310 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

jpeetz/agent-skills · 9 stars · license none · pushed 2026-09-21 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_nkdjcwm24i3ifflz
GET https://markdownregistry.com/api/v1/resolve?ref=jpeetz/agent-skills/documentation-and-adrs
GET https://markdownregistry.com/api/v1/blob/dfea4a4c21ff1292483e68b1131c6095edcdfdc0297c22d7264f16b1c9f5aab8

Your agent 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.

More from jpeetz/agent-skills

api-design-first skill
jpeetz/agent-skills · skills/api-backend/api-design-first/SKILL.md · Design-first API development skill. Generates OpenAPI 3.1 specifications, enforces REST design best practices…
v1.0.0 · audit A · 9 stars
graphql-api-development skill
jpeetz/agent-skills · skills/api-backend/graphql-api-development/SKILL.md · AI-powered GraphQL API design, implementation, and optimization. Covers schema-first design, resolver architecture…
v1.0.0 · audit A · 9 stars
har-api-reverse-engineering skill
jpeetz/agent-skills · skills/api-backend/har-api-reverse-engineering/SKILL.md · Use this skill when an agent needs to call a website's hidden or undocumented API: capture real browser requests into a…
v1.0.0 · audit A · 9 stars
image-to-image-character-generation skill
jpeetz/agent-skills · skills/api-backend/image-to-image-character-generation/SKILL.md · Use this skill when an agent needs to generate consistent character images via kie.ai grok-imagine image-to-image from…
v1.0.0 · audit A · 9 stars
social-har-api-connectivity skill
jpeetz/agent-skills · skills/api-backend/social-har-api-connectivity/SKILL.md · Use this skill when an agent needs to connect to a social platform's API by prompting the user to pick a platform…
v3.0.0 · audit A · 9 stars
app-discovery-scrutiny skill
jpeetz/agent-skills · skills/business-strategy/app-discovery-scrutiny/SKILL.md · Use this skill when the user wants to evaluate a mobile app idea for commercial viability — whether it's a clone…
git:20260914.5722530 · audit A · 9 stars
enterprise-consulting-methods skill
jpeetz/agent-skills · skills/business-strategy/enterprise-consulting-methods/SKILL.md · Use when you need McKinsey/BCG-grade strategy work — problem decomposition, hypothesis testing, storyline building…
v1.0.0 · audit A · 9 stars
linear-project-management skill
jpeetz/agent-skills · skills/business-strategy/linear-project-management/SKILL.md · Use when driving Linear projects and issues from an agent.
v1.0.0 · audit A · 9 stars
clean-pro-review-gates skill
jpeetz/agent-skills · skills/code-quality/clean-pro-review-gates/SKILL.md · Combined 5-gate review framework that catches AI-generated code failures before shipping — code quality (15 LLM failure…
v1.0.0 · audit A · 9 stars
code-review skill
jpeetz/agent-skills · skills/code-quality/code-review/SKILL.md · AI-powered code review and PR analysis. Performs systematic reviews covering security vulnerabilities, code quality…
v1.1.0 · audit A · 9 stars
code-simplification skill
jpeetz/agent-skills · skills/code-quality/code-simplification/SKILL.md · Use this skill when refactoring code for clarity without changing behavior. Use when code works but is harder to read…
v1.0.0 · audit A · 9 stars
debugging-and-error-recovery skill
jpeetz/agent-skills · skills/code-quality/debugging-and-error-recovery/SKILL.md · Use this skill when tests fail, builds break, runtime behavior doesn't match expectations, a bug report arrives, or…
v1.0.0 · audit A · 9 stars

Every file in jpeetz/agent-skills

Other files named documentation-and-adrs

documentation-and-adrs skill
addyosmani/agent-skills · skills/documentation-and-adrs/SKILL.md · Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning…
git:20260907.cda4542 · audit A · 98,554 stars
documentation-and-adrs 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 · 158 stars
documentation-and-adrs 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 · 85 stars
documentation-and-adrs 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 · 85 stars
documentation-and-adrs 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 · 85 stars
documentation-and-adrs skill
nota-america/forgecat-agent-profiles · profiles/addyosmani/agent-skills/for-forgecat/skills/documentation-and-adrs/SKILL.md · Records decisions and documentation. Use when making architectural decisions, changing public APIs, shipping features…
git:20260610.c645100 · audit A · 85 stars
documentation-and-adrs 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 · 85 stars
documentation-and-adrs 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 · 85 stars

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