documentation-and-adrs

Create Architecture Decision Records with sequential numbering and standard templates.

2|Updated Mar 6, 2026
One-click install
npx skills add https://github.com/GoBeromsu/obsidian-workspace --skill documentation-and-adrs-goberomsu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/GoBeromsu/obsidian-workspace/tree/main/.claude/skills/documentation-and-adrs
Command: npx skills add https://github.com/GoBeromsu/obsidian-workspace --skill documentation-and-adrs-goberomsu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Document decisions, not just code. Capture the context, constraints, and trade-offs that led to a decision, so future engineers and agents understand the rationale behind choices.

Core Features & Use Cases

  • Create Architecture Decision Records (ADRs) with sequential numbering and a standard template.
  • Provide inline documentation guidance and avoid restating obvious code, focusing on the why and what alternatives were considered.
  • Maintain ADR lifecycles and verification steps to ensure governance and knowledge retention across projects.

Quick Start

Create a new ADR using the ADR template and add inline documentation for the decision.

Frequently Asked Questions about documentation-and-adrs

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

FAQPage Schema
How do I create Architecture Decision Records to document project rationale?

Architecture Decision Records document decisions by capturing context, constraints, and trade-offs using a standard template with sequential numbering to preserve rationale for future engineers and agents across repositories.

What is the best way to maintain ADR lifecycles and governance across multiple repositories?

Maintaining ADR lifecycles involves applying standard templates, sequential numbering, and verification steps across repositories to ensure project governance, traceability, and knowledge retention for future engineering teams.

When do I need to write inline documentation for architectural choices?

Inline documentation is needed when architectural choices, API design, or governance decisions require context that code alone cannot provide, focusing on the why and what alternatives were considered rather than restating obvious code.

How do I document API design decisions to ensure traceability for future agents?

Documenting API design decisions uses the ADR structure to record context, constraints, and trade-offs, applying inline documentation standards and verification steps to ensure traceability and preserve rationale for future engineers and agents.

Does this approach to decision records work for project governance across different repositories?

Yes, the decision records approach applies to project governance across repositories by conforming to standard ADR structures, maintaining lifecycles, and running verification steps to ensure traceability and knowledge retention.

Why avoid restating obvious code in inline documentation for decision records?

Inline documentation for decision records avoids restating obvious code to focus on the rationale behind decisions, capturing the why and what alternatives were considered, ensuring future engineers understand context without redundant explanations.