documentation-and-adrs

documentation-and-adrs is a skill for Claude Code from 233i/agent-skills. It costs 46 tokens per session (2,137 once invoked), scanned A, original, MIT.

A guide for recording important engineering decisions and the reasons behind them. An ADR, or architecture decision record, is a short document that explains a major technical choice, its context, and the alternatives considered.

In plain words
What is it for?
Use it for architecture choices, database designs, authentication, APIs, major dependencies, public API changes, and user-visible features with lasting consequences.
Why use it?
It preserves knowledge that code alone cannot show, so future engineers and coding agents can understand why the system works this way. It also reduces the need to explain the same decision repeatedly.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin. Also seen: mentions CLAUDE.md.

Part of the agent-skills plugin — 20 skills, 7 commands, 3 agents, 1 hook shipped together

Good fit Use it for architecture choices, database designs, authentication, APIs, major dependencies, public API changes, and user-visible features with lasting consequences.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/233i/agent-skills/documentation-and-adrs
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add 233i/agent-skills --skill documentation-and-adrs
Clone the repo
git clone --depth 1 https://github.com/233i/agent-skills

Made for: Claude Code.

Or install agent-skills, the plugin that ships this one along with the rest of its 20 skills, 7 commands, 3 agents, 1 hook.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for documentation-and-adrs

README.md
[![agentmods](https://agentmods.dev/badge/skills/233i/agent-skills/documentation-and-adrs/github.svg)](https://agentmods.dev/skills/233i/agent-skills/documentation-and-adrs)
Your own site
<a href="https://agentmods.dev/skills/233i/agent-skills/documentation-and-adrs"><img src="https://agentmods.dev/badge/skills/233i/agent-skills/documentation-and-adrs/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for documentation-and-adrs

Your own site · 80×15
<a href="https://agentmods.dev/skills/233i/agent-skills/documentation-and-adrs"><img src="https://agentmods.dev/badge/skills/233i/agent-skills/documentation-and-adrs.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 46 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,137 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00046 $0.02137
Opus 5 $0.00023 $0.01069
Sonnet 5 $0.00009 $0.00427
Haiku 4.5 $0.00005 $0.00214

Measured 10d ago against content hash 4afb54efa596, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-10, from the pricing page.

Security

Grade A, and why

documentation-and-adrs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 10d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/documentation-and-adrs/SKILL.md · 279 lines

How it starts

The opening of the file, as written. The whole thing — 279 lines — stays where its author put it; the contents beside it link to each section on GitHub.

文档与 ADR

概览

记录的不只是代码,更要记录决策。最有价值的文档,保存的是 why,也就是做出这个决定时的背景、约束和权衡。代码展示了 what 被构建出来,文档解释了 why it was built this way,以及 what alternatives were considered。这些背景信息,对未来继续维护代码库的人类和 agent 都至关重要。

何时使用

  • 做重要的架构决策
  • 在多个方案之间做选择
  • 新增或修改公开 API
  • 发布会改变用户可见行为的功能
  • 帮助新成员或新 agent 理解项目
  • 当你发现自己在重复解释同一件事时

不适用的场景: 不要为显而易见的代码写文档;不要写只是复述代码内容的注释;也不要给一次性原型写厚重文档。

架构决策记录(ADR)

ADR 用于记录重要技术决策背后的推理过程。它们是你能写出的最高价值文档之一。

什么时候该写 ADR

  • 选择框架、库或关键依赖
  • 设计数据模型或数据库 schema
  • 确定认证策略
  • 决定 API 架构,例如 REST、GraphQL 或 tRPC
  • 在构建工具、托管平台或基础设施之间做选择
  • 任何将来回滚代价很高的决策

ADR 模板

将 ADR 按顺序编号,存放在 docs/decisions/ 中:

# ADR-001: Use PostgreSQL for primary database

## Status
Accepted | Superseded by ADR-XXX | Deprecated

## Date
2025-01-15

## Context
We need a primary database for the task management application. Key requirements:
- Relational data model (users, tasks, teams with relationships)
- ACID transactions for task state changes
- Support for full-text search on task content
- Managed hosting available (for small team, limited ops capacity)

## Decision
Use PostgreSQL with Prisma ORM.

## Alternatives Considered

### MongoDB
- Pros: Flexible schema, easy to start with
- Cons: Our data is inherently relational; would need to manage relationships manually
- Rejected: Relational data in a document store leads to complex joins or data duplication

### SQLite
- Pros: Zero configuration, embedded, fast for reads
- Cons: Limited concurrent write support, no managed hosting for production
- Rejected: Not suitable for multi-user web application in production

### MySQL
- Pros: Mature, widely supported
- Cons: PostgreSQL has better JSON support, full-text search, and ecosystem tooling
- Rejected: PostgreSQL is the better fit for our feature requirements

## Consequences
- Prisma provides type-safe database access and migration management
- We can use PostgreSQL's full-text search instead of adding Elasticsearch
- Team needs PostgreSQL knowledge (standard skill, low risk)
- Hosting on managed service (Supabase, Neon, or RDS)

Read the full file on GitHub · 279 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 10d ago First seen · 279 lines · 46 tokens per session scan A 4afb54efa596

Subscribe to this mod's changes

documentation-and-adrs is a skill published in the GitHub repository 233i/agent-skills (6 stars, last pushed 5mo ago), licensed MIT. It adds 46 tokens to every session and 2,137 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

insight-error-page

Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…

vercel/next.js · 83 tokens

next-cache-components-optimizer

Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…

vercel/next.js · 170 tokens

next-partial-prefetching-adoption

Turn on Partial Prefetching in a Next.js app and work through the insights it surfaces. Use when the user wants to enable or adopt Partial Prefetching, flip the partialPrefetching flag, opt routes in with export const prefetch = 'partial', audit Link prefetch={true} behavior, preserve existing prefetched UI with…

vercel/next.js · 103 tokens