One-click install
npx skills add https://github.com/rvdbreemen/OTGW-firmware --skill adr-rvdbreemen
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: adr
Source: https://github.com/rvdbreemen/OTGW-firmware/tree/main/.claude/skills/adr
Command: npx skills add https://github.com/rvdbreemen/OTGW-firmware --skill adr-rvdbreemen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents architectural drift by ensuring important engineering decisions for OTGW-firmware are documented, discoverable, and consistently followed during development.

Core Features & Use Cases

  • Creates and curates Architecture Decision Records (ADRs): Captures decision context, alternatives, and consequences so future developers understand the “why.”
  • Supports architectural compliance: Helps PRs and CI/CD workflows validate that changes align with existing decisions, or triggers a new ADR when needed.
  • Guides initial ADR discovery: On first use, performs a systematic scan to identify undocumented architectural choices and documents them as Accepted ADRs.
  • Enforces ADR governance principles: Promotes immutable history and supersession (never modifying accepted ADRs), with clear status/category conventions.

Quick Start

Use the adr skill to document a major architectural change by asking it to create a new ADR with context, alternatives, consequences, and affected file links for the OTGW-firmware codebase.

Frequently Asked Questions about adr

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

FAQPage Schema
How do I enforce architecture decision records in CI/CD pipelines?▼

Enforcing architecture decision records in CI/CD pipelines involves validating pull requests against existing decisions and triggering a new ADR when changes introduce major design trade-offs. This prevents architectural drift by ensuring compliance checks fail on undocumented modifications.

What is the best way to document architectural trade-offs and system design decisions?▼

Documenting architectural trade-offs requires creating comprehensive Architecture Decision Records that capture context, constraints, alternatives considered and rejected, consequences, and implementation verification guidance. This ensures future developers understand the reasoning behind long-term system design choices.

How do I discover undocumented architectural choices in an existing firmware codebase?▼

Discovering undocumented architectural choices in a firmware codebase is done through a systematic initial ADR discovery scan. This process identifies existing design decisions and automatically documents them as Accepted Architecture Decision Records to establish a baseline governance history.

Can I modify an accepted architecture decision record to reflect new codebase constraints?▼

Modifying an accepted architecture decision record violates ADR governance principles which promote immutable history. Instead of editing accepted records, you must create a new ADR that explicitly supersedes the previous one, documenting the new constraints and updated trade-offs.

When do I need to create a new architecture decision record for a refactoring proposal?▼

You need to create a new architecture decision record for refactoring proposals when changes involve major design modifications or cross-component decisions where long-term trade-offs matter. This ensures the architectural impact is analyzed, documented, and aligned with the existing system design.