obsidian-adr
Skill0 starsChanged 5 months agoMITView on GitHub
Specialist skill for Architecture Decision Records (ADRs) in an Obsidian vault. Normally invoked by the obsidian-documentation orchestrator. Use whenever a technical decision was made or is being made — "we decided to…", "we chose X over Y", "record this decision", "why did we pick…" — even if the user doesn't say "ADR". Creates numbered records under ADRs/ and manages their lifecycle (proposed, accepted, superseded).
In this repository9 other files it gives its agents.
- obsidian-architectureSkill
- obsidian-doc-prompterSkill
- obsidian-documentationSkill
- obsidian-excalidrawSkill
- obsidian-featureSkill
- obsidian-linkingSkill
- obsidian-maintenanceSkill
- obsidian-querySkill
- obsidian-taggingSkill
The file
We split this skill into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 21
The "why" is mandatory: If the conversation contains the decision but not the reasoning or the alternatives considered, ask.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
ADR Specialist
You record decisions and their reasoning so future readers understand why the system is the way it is. Output goes to ADRs/ as ADR-NNNN - Short Title.md.
Read ../obsidian-documentation/references/conventions.md first.
When to use / not use
- Use: a choice between alternatives was made (library, pattern, architecture, process), or the user wants the reasoning behind an existing choice preserved
- Don't use: describing how something works (→ obsidian-feature / obsidian-architecture). An ADR captures the fork in the road, not the road.
Rules
- Numbering: scan
ADRs/for the highest existing number and increment. Never renumber existing ADRs. - Immutability: accepted ADRs are historical records. Don't rewrite them when things change — write a new ADR that supersedes the old one, and update the old ADR's status to
superseded by [[ADR-NNNN - …]]. - The "why" is mandatory. If the conversation contains the decision but not the reasoning or the alternatives considered, ask. An ADR without honest trade-offs is worthless.
- One decision per ADR. Two decisions → two ADRs.
ADR template
---
created: <date>
updated: <date>
type: adr
status: proposed | accepted | superseded | rejected
tags: [adr, <domain tags>]
related: ["[[<affected notes>]]"]
---
# ADR-NNNN: <Decision in one short sentence>
## Status
<accepted (YYYY-MM-DD)> <"superseded by [[ADR-MMMM - …]]" if applicable>
## Context
<The situation that forced a choice, in plain language. What problem,
what constraints (time, money, team, tech).>
## Decision
<What was decided, stated plainly. "We will use GraphQL for all new
client-facing APIs.">
## Alternatives considered
<Each real alternative with its honest pros/cons and why it lost.>
## Consequences
<What gets better, what gets worse, what we accept. Include the costs —
every decision has them.>
## Related
- [[ADRs MOC]]
- <affected architecture/feature notes>After writing
Tell the orchestrator which existing notes are affected so obsidian-linking can connect them (the affected architecture note should link to the ADR and vice versa), and whether obsidian-architecture should update an overview to reflect the decision.
Example
Input: "We're going with Postgres over DynamoDB for the orders service — the access patterns are too relational."
Output: ADRs/ADR-0012 - Use Postgres for Orders Service.md with status accepted, context (relational access patterns, team familiarity), alternatives (DynamoDB: scales better, but awkward joins and unfamiliar), consequences (must manage migrations and connection pooling; gains flexible querying). Flags Architecture/Orders Service.md for linking.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

