skills.rest
AskTinNguyen
AskTinNguyenCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation-and-adrs

Capture architectural decisions with ADR templates and lifecycle guidance.

1|Updated Jan 26, 2026
Search Tags:#architecture#documentation#adr#decision-records#inline-docs#adr-template
One-click install
npx skills add https://github.com/AskTinNguyen/vesper-team-skills --skill documentation-and-adrs-asktinnguyen
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/AskTinNguyen/vesper-team-skills/tree/main/documentation-and-adrs
Command: npx skills add https://github.com/AskTinNguyen/vesper-team-skills --skill documentation-and-adrs-asktinnguyen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Document decisions to preserve why, constraints, and trade-offs behind code and architecture, ensuring future engineers and agents understand the rationale beyond the code.

Core Features & Use Cases

  • ADR creation and template usage to capture architecture decisions.
  • Placement and lifecycle guidance for ADRs and inline documentation (docs/decisions/).
  • Inline documentation practices, ADR lifecycle, and governance guidance to align teams across projects.

Quick Start

Create your first ADR for a major decision and store it under docs/decisions/ with a sequential number.

Frequently Asked Questions about documentation-and-adrs

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

FAQPage Schema
What is an architectural decision record and when do I need one?▼

An ADR captures the context, constraints, and trade-offs behind a design choice. You need an ADR when a major architectural decision impacts future engineers' understanding of why specific code or system structures were chosen.

How do I start writing an ADR for my software project?▼

To start writing an ADR, use an ADR template to document your architectural decision, then store the file under docs/decisions/ with a sequential number to maintain a clear, organized lifecycle for future reference.

Where should architectural decision records and inline documentation be placed?▼

Architectural decision records should be placed under docs/decisions/ with sequential numbering. Inline documentation practices and ADR lifecycle guidance help align teams across software projects for future clarity.

Can I use ADR templates for inline documentation and team governance?▼

Yes, ADR templates support inline documentation practices and governance guidance. They help align teams across projects by documenting context, constraints, and trade-offs within the standard ADR lifecycle workflow.

What is the best way to document architectural trade-offs for future engineers?▼

The best way to document architectural trade-offs is using ADR templates to record decisions and inline documentation. This preserves the rationale, constraints, and context behind code and architecture for future engineers.

Why does preserving architectural context matter for software projects?▼

Preserving architectural context matters because it ensures future engineers and agents understand the rationale, constraints, and trade-offs behind code and architecture beyond the implementation itself.

Related Skills

Explore More Software Engineering Skills→
farzanmrzfarzanmrz
6

documentation-and-adrs

Record architecture decisions and rationale in structured ADR templates.

Community
Intermediate
GoBeromsuGoBeromsu
2

documentation-and-adrs

Create Architecture Decision Records with sequential numbering and standard templates.

Community
Advanced
nesihaver-ILnesihaver-IL

update-docs

Update README, API, architecture docs, and changelogs after code changes.

Community
Intermediate
nahisahonahisaho
69

system-architect

Generate Mermaid C4 diagrams and ADRs for system architecture design.

Community
Advanced