skills.rest
koolerkx
koolerkxCOMMUNITY
Explore all skills by this author →
𝕏@koolerkxGitHub

documentation-and-adrs

Record architectural decisions and API changes with ADR templates.

Updated May 26, 2026
Search Tags:#documentation#onboarding#codebase#adr#guidelines#architecture-decision#decision-record
One-click install
npx skills add https://github.com/koolerkx/vibe-react-2d-map-editor-yaml --skill documentation-and-adrs-koolerkx
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/koolerkx/vibe-react-2d-map-editor-yaml/tree/main/.claude/skills/documentation-and-adrs
Command: npx skills add https://github.com/koolerkx/vibe-react-2d-map-editor-yaml --skill documentation-and-adrs-koolerkx

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Records architectural decisions and API changes to preserve rationale and context for future engineers and agents.

Core Features & Use Cases

  • ADRs capture reasoning, trade-offs, and alternatives for major decisions.
  • Inline documentation and guidelines help onboard new teammates and maintain codebase clarity.
  • Documentation for agents (CLAUDE.md, specs) ensures consistent interpretation of project conventions.

Quick Start

Create or update an ADR following the ADR lifecycle and link it to related decisions.

Frequently Asked Questions about documentation-and-adrs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is an architecture decision record and when should I document one?▼

An architecture decision record (ADR) captures the reasoning, trade-offs, and alternatives for major decisions. You should document architectural decisions and API changes whenever future engineers or agents need to understand the why behind specific choices.

How do I write an ADR to preserve architectural context for onboarding?▼

To write an ADR for onboarding, follow the ADR lifecycle to record architectural decisions and API changes. Use ADR templates and inline documentation to capture guidelines, ensuring new teammates and agents maintain codebase clarity.

Can I use inline documentation and guidelines for agent-friendly project conventions?▼

Yes, you can use inline documentation and guidelines to support agent-friendly guidance. Documentation for agents, such as CLAUDE.md and specs, ensures consistent interpretation of project conventions and maintains traceable codebase evolution.

What is the best way to link related architectural decisions in a codebase?▼

The best way to link related architectural decisions is to create or update an ADR following the ADR lifecycle. Link it to related decisions to preserve rationale and context, ensuring maintainable evolution and traceable architecture across the codebase.

Does documenting API changes with ADRs work for agent-based codebase evolution?▼

Documenting API changes with ADRs works effectively for agent-based evolution by preserving rationale and context. It provides agent-friendly guidance through specs and CLAUDE.md, ensuring agents consistently interpret project conventions and architectural decisions.

Related Skills

Explore More Software Engineering Skills→
TaylorHustonTaylorHuston
69

adr

Create Architecture Decision Records using a standard template.

Community
Basic
unfinishablemapunfinishablemap
3

expand-topic

Generate a publish-ready article draft from a topic prompt.

Community
Intermediate
VoDaiLoczVoDaiLocz
24

lint-and-validate

Automate linting and static analysis of code in CI pipelines.

Community
Intermediate
tradertunantetradertunante

documentation-and-adrs

Record architectural decisions and documentation within the repository.

Community
Advanced