Документация и ADR
Записывает решения в ADR по формату проекта, документирует API, README и changelog с упором на «почему», по истории git проверяет, не устарел ли документ. Для случаев, когда принято дорогое решение, меняется публичный API или документы разошлись с кодом.
documentation-and-adrs- Автор
- Addy Osmani
- Источник
- addyosmani/agent-skills/skills/documentation-and-adrs @ 8c99fa3
- Лицензия
- MIT · Copyright (c) 2025 Addy Osmani
Об этом скилле
Что делает
Скилл — общее руководство по документации, в котором на первом месте «почему»: записи архитектурных решений (ADR), комментарии о намерении, документация API, README, changelog и заметки для агентов. Для ADR агент сначала ищет принятый в проекте порядок (существующие ADR, инструкции проекта, файл .adr-dir) и повторяет его папку, разметку, нумерацию и заголовки. Только если порядка нет, берёт свой: папку docs/decisions/, сквозную нумерацию и шаблон со статусом, датой, контекстом, решением, альтернативами и последствиями. Старые ADR не удаляются: если решение поменялось, пишется новая запись, которая заменяет прежнюю.
Две части выходят за рамки шаблонов. Расхождение с кодом: чтобы понять, устарел ли документ, агент сравнивает последние коммиты кода и документа через git log и git merge-base --is-ancestor (скрипт есть в SKILL.md), а если порядок истории не определить (разошедшиеся ветки, rebase, неполный клон), отвечает «не понять», но никогда «актуален». Вычитка текста: после правки формулировок имена, числа, команды, ссылки, условия и оговорки должны остаться на месте и совпадать с источниками. Журнал изменений документа только дополняется, переписывать его нельзя. В папке только SKILL.md и лицензия.
Когда включать и когда не надо
Для решения, которое дорого отменить (фреймворк, база, авторизация, стиль API), нового или изменённого публичного API, фичи, меняющей поведение для пользователя, и документации, которая, похоже, разошлась с кодом.
Сам скилл исключает очевидный код, комментарии, пересказывающие код, и прототипы на выброс. В описании упомянута проверка, которая не даст документации снова незаметно устареть; в тексте есть скрипт для разовой проверки, а рецепта для CI нет.
Как поставить и вызвать
Команда установки ниже кладёт SKILL.md и лицензию. Агент сам подхватывает скилл по описанию. Вызвать вручную:
- Claude Code:
/documentation-and-adrsили попросить скилл по имени. - Codex:
$documentation-and-adrs. - Cursor: наберите
/в чате Agent и выберитеdocumentation-and-adrs.
Пример: /documentation-and-adrs Мы перешли с REST-опроса на WebSocket. Напиши ADR и скажи, какие файлы в docs/ теперь устарели.
Чем отличается от похожих
В нашем наборе docs та же работа разложена на узкие скиллы. Запись архитектурного решения (ADR) тоже следует принятому порядку, но по умолчанию берёт docs/adr/ и спрашивает, прежде чем её создать, требует минимум двух настоящих вариантов и строки «когда пересмотреть», а факты сверяет с вами до финальной версии. Написание README запускает каждую команду, которую описывает, Чистка комментариев в коде трогает только строки комментариев и проверяет это по диффу, а Changelog и release notes собирает заметки из коммитов после последнего тега. Этот скилл даёт короткие версии всего этого и две вещи, которых нет ни в одном из них: проверку устаревания по истории git и вычитку текста. Если нужен один конкретный документ, узкий скилл проработает его глубже. Модель предметной области тоже ведёт ADR, но как короткий побочный продукт глоссария проекта. Ревью текстов по Writing Guidelines занимается только вычиткой, зато глубже: сверяет англоязычный текст со справочником стиля Vercel и выдаёт находки с номерами строк.
Установка
Выполните одну команду — она сохранит SKILL.md и файлы, которые он использует, в папку скиллов агента. Claude Code и Codex подхватывают новый скилл без перезапуска; если скилл не появился, перезапустите агента.
Скилл написан на английском — агент поймёт его и ответит вам по-русски.
curl -fsSL --create-dirs -o ~/.claude/skills/documentation-and-adrs/SKILL.md https://anymodel.org/en/skills/addy-osmani/documentation-and-adrs/SKILL.md -o ~/.claude/skills/documentation-and-adrs/LICENSE https://anymodel.org/en/skills/addy-osmani/documentation-and-adrs/LICENSE
curl -fsSL --create-dirs -o ~/.agents/skills/documentation-and-adrs/SKILL.md https://anymodel.org/en/skills/addy-osmani/documentation-and-adrs/SKILL.md -o ~/.agents/skills/documentation-and-adrs/LICENSE https://anymodel.org/en/skills/addy-osmani/documentation-and-adrs/LICENSE
foreach ($f in 'SKILL.md','LICENSE') { $p = Join-Path "$HOME\.claude\skills\documentation-and-adrs" $f; New-Item -ItemType Directory -Force (Split-Path $p) | Out-Null; Invoke-WebRequest "https://anymodel.org/en/skills/addy-osmani/documentation-and-adrs/$f" -UseBasicParsing -OutFile $p }foreach ($f in 'SKILL.md','LICENSE') { $p = Join-Path "$HOME\.agents\skills\documentation-and-adrs" $f; New-Item -ItemType Directory -Force (Split-Path $p) | Out-Null; Invoke-WebRequest "https://anymodel.org/en/skills/addy-osmani/documentation-and-adrs/$f" -UseBasicParsing -OutFile $p }Другой агент: сохраните файл в его папку скиллов или дайте ему ссылку на файл: https://anymodel.org/en/skills/addy-osmani/documentation-and-adrs/SKILL.md
SKILL.md
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
- Deciding on an API architecture (REST vs. GraphQL vs. tRPC)
- Choosing between build tools, hosting platforms, or infrastructure
- Any decision that would be expensive to reverse
Match the existing convention first
Before creating an ADR, inspect the available repository context for an established convention — existing ADRs, project instructions, and ADR-related configuration or tooling (e.g. an .adr-dir file). An established convention overrides the defaults below. Match:
- Location and format — e.g.
docs/adr/*.md,Documentation/Decisions/*.rst, a MADR layout, or anadr-toolssetup. Match the existing directory, file extension, and markup (Markdown vs reStructuredText). - Numbering and naming — continue the existing sequence and filename pattern (
ADR-004-Title.rst,0004-title.md, …); don't restart at 001 or introduce a second scheme. - Section headings — reuse the project's heading set rather than imposing this template's.
If the available evidence conflicts, surface the conflict rather than silently introducing another scheme. Only when no convention can be established do you apply the default below.
ADR Template
Store ADRs in docs/decisions/ with sequential numbering (unless the project already uses another location — see above):
# ADR-001: Use PostgreSQL for primary database
## Status
Proposed | 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)
ADR Lifecycle
PROPOSED → ACCEPTED → (SUPERSEDED or DEPRECATED)
- Don't delete old ADRs. They capture historical context.
- When a decision changes, write a new ADR that references and supersedes the old one.
Inline Documentation
When to Comment
Comment the why, not the what:
// BAD: Restates the code
// Increment counter by 1
counter += 1;
// GOOD: Explains non-obvious intent
// Rate limit uses a fixed window that opens on the first request after the
// previous one expires, not on a clock schedule. Known gap: a client can spend
// the full limit just before a reset and again just after (2x in a moment)
if (now - windowStart > WINDOW_SIZE_MS) {
counter = 0;
windowStart = now;
}
When NOT to Comment
// Don't comment self-explanatory code
function calculateTotal(items: CartItem[]): number {
return items.reduce((sum, item) => sum + item.price * item.quantity, 0);
}
// Don't leave TODO comments for things you should just do now
// TODO: add error handling ← Just add it
// Don't leave commented-out code
// const oldImplementation = () => { ... } ← Delete it, git has history
Document Known Gotchas
/**
* IMPORTANT: This function must be called before the first render.
* If called after hydration, it causes a flash of unstyled content
* because the theme context isn't available during SSR.
*
* See ADR-003 for the full design rationale.
*/
export function initializeTheme(theme: Theme): void {
// ...
}
API Documentation
For public APIs (REST, GraphQL, library interfaces):
Inline with Types (Preferred for TypeScript)
/**
* Creates a new task.
*
* @param input - Task creation data (title required, description optional)
* @returns The created task with server-generated ID and timestamps
* @throws {ValidationError} If title is empty or exceeds 200 characters
* @throws {AuthenticationError} If the user is not authenticated
*
* @example
* const task = await createTask({ title: 'Buy groceries' });
* console.log(task.id); // "task_abc123"
*/
export async function createTask(input: CreateTaskInput): Promise<Task> {
// ...
}
OpenAPI / Swagger for REST APIs
paths:
/api/tasks:
post:
summary: Create a task
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTaskInput'
responses:
'201':
description: Task created
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'422':
description: Validation error
README Structure
Every project should have a README that covers:
# Project Name
One-paragraph description of what this project does.
## Quick Start
1. Clone the repo
2. Install dependencies: `npm install`
3. Set up environment: `cp .env.example .env`
4. Run the dev server: `npm run dev`
## Commands
| Command | Description |
|---------|-------------|
| `npm run dev` | Start development server |
| `npm test` | Run tests |
| `npm run build` | Production build |
| `npm run lint` | Run linter |
## Architecture
Brief overview of the project structure and key design decisions.
Link to ADRs for details.
## Contributing
How to contribute, coding standards, PR process.
Changelog Maintenance
For shipped features:
# Changelog
## [1.2.0] - 2025-01-20
### Added
- Task sharing: users can share tasks with team members (#123)
- Email notifications for task assignments (#124)
### Fixed
- Duplicate tasks appearing when rapidly clicking create button (#125)
### Changed
- Task list now loads 50 items per page (was 20) for better UX (#126)
Documentation for Agents
Special consideration for AI agent context:
- CLAUDE.md / rules files — Document project conventions so agents follow them
- Spec files — Keep specs updated so agents build the right thing
- ADRs — Help agents understand why past decisions were made (prevents re-deciding)
- Inline gotchas — Prevent agents from falling into known traps
Prose Review
After checking the technical content, review the prose for the people who will use it. Clearer wording must not change the decision or its limits.
- Mark the details that must survive the edit: names, numbers and units, commands, paths, links, conditions, trade-offs, and uncertainty. Check them against the available code and decision context; flag anything you cannot substantiate.
- Replace stock introductions, promotional adjectives, and repeated summaries with the concrete information the reader needs. Do not replace an unsupported claim with an invented example or a stronger guarantee. Keep necessary technical repetition and the project's established terminology.
- Compare the edited document with the original and its sources. Restore any lost qualifier or caveat, verify command and code examples still work as documented, and explain any unresolved factual question rather than polishing it away.
Documentation Drift
A document that was true when written still reads as authoritative after the code moves on. When a doc may be stale, decide from version control, not from how confident the doc sounds:
code=$(git log -1 --format=%H -- src/rate-limiter.js)
doc=$(git log -1 --format=%H -- docs/rate-limiter.md)
if [ "$code" = "$doc" ]; then echo "current: changed together"
elif git merge-base --is-ancestor "$doc" "$code"; then echo "stale: code changed after the doc"
elif git merge-base --is-ancestor "$code" "$doc"; then echo "current: doc changed after the code"
else echo "can't tell"; fi
Unordered history (divergent branches, a rebase, a shallow clone) means "can't tell". Say that; never report it as current.
When you correct a doc that has a change log, append a dated entry that says why it changed. Never rewrite or collapse earlier entries: git keeps the old text, but the log is the only record of the reasons.
Common Rationalizations
| Rationalization | Reality |
|---|---|
| "The code is self-documenting" | Code shows what. It doesn't show why, what alternatives were rejected, or what constraints apply. |
| "We'll write docs when the API stabilizes" | APIs stabilize faster when you document them. The doc is the first test of the design. |
| "Nobody reads docs" | Agents do. Future engineers do. Your 3-months-later self does. |
| "ADRs are overhead" | A 10-minute ADR prevents a 2-hour debate about the same decision six months later. |
| "Comments get outdated" | Comments on why are stable. Comments on what get outdated — that's why you only write the former. |
| "I'll tidy the change log while I'm in here" | Git holds the old text; the log holds the reasons. Rewriting it destroys the only copy of the reasoning and preserves nothing. |
Red Flags
- Architectural decisions with no written rationale
- Public APIs with no documentation or types
- README that doesn't explain how to run the project
- Commented-out code instead of deletion
- TODO comments that have been there for weeks
- No ADRs in a project with significant architectural choices
- Documentation that restates the code instead of explaining intent
- A change log that has been rewritten rather than appended to
- A doc called current when the commit order of the doc and its code could not be determined
Verification
After documenting:
- ADRs exist for all significant architectural decisions
- README covers quick start, commands, and architecture overview
- API functions have parameter and return type documentation
- Known gotchas are documented inline where they matter
- No commented-out code remains
- Rules files (CLAUDE.md etc.) are current and accurate
- Prose edits preserve source details, decision trade-offs, and qualifiers without adding unsupported guarantees
- Change logs were appended to rather than rewritten
- A doc whose staleness could not be determined is reported as "can't tell", not as current
Подключить через AnyModel API
Скилл работает на той модели, которую использует агент. Подключите Claude Code, Codex или Cursor к AnyModel и запускайте его на Claude, GPT, Gemini и других моделях по одному ключу — оплата за токены, без подписки.
AnyModel