documentation-and-adrs

Document architectural decisions and ADRs under docs/decisions with sequential numbering.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Document architectural decisions and ADRs to preserve rationale for future engineers and agents working in the codebase.

Core Features & Use Cases

  • ADR templates for consistent decision records
  • Inline guidance to capture context, constraints, and trade-offs
  • Structured references to related API changes and public interfaces

Quick Start

Initiate an ADR session by outlining the decision, its context, and trade-offs.

Frequently Asked Questions about documentation-and-adrs

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

FAQPage Schema
How do I document architecture decisions for my engineering team?

You document architecture decisions by capturing the context, constraints, and trade-offs of your choices. This Skill provides ADR templates and inline guidance to preserve rationale for future engineers, organizing records sequentially under docs/decisions.

What is an ADR and when do I need to create one?

An ADR is an Architecture Decision Record that documents the rationale behind technical choices. You need to create one when making architectural decisions, API changes, or public API updates to preserve the reasoning for future engineers.

How do I write an ADR for API changes and public interface updates?

To write an ADR for API changes, you outline the decision, its context, and trade-offs. The Skill provides inline guidance and structured references to related API changes and public interfaces to ensure comprehensive documentation.

Can I use ADR templates for onboarding new engineers to a codebase?

Yes, you can use ADR templates for onboarding teams. By documenting architectural decisions and preserving rationale under docs/decisions, new engineers and agents can quickly understand the context and constraints of existing system choices.

What is the best way to organize architecture decision records in a repository?

The best way to organize architecture decision records is sequentially numbering them under docs/decisions. This Skill handles the organization automatically while providing templates to ensure consistent decision capture across the team.

Does this ADR documentation approach work without external dependencies?

Yes, this ADR documentation approach works without external dependencies. It relies on built-in ADR templates and inline guidance to capture context and trade-offs, requiring no specific frameworks or components to start documenting decisions.