skills.rest
vtgiang-dotcom
vtgiang-dotcomCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation-and-adrs

Record architectural decisions as ADRs under docs/decisions with lifecycle statuses.

3|Updated Apr 1, 2026
Search Tags:#architecture#documentation#adr#governance#engineering#docs#decision-record
One-click install
npx skills add https://github.com/vtgiang-dotcom/Solo-Code-Harness --skill documentation-and-adrs-vtgiang-dotcom
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/vtgiang-dotcom/Solo-Code-Harness/tree/main/.gemini/antigravity/skills/documentation-and-adrs
Command: npx skills add https://github.com/vtgiang-dotcom/Solo-Code-Harness --skill documentation-and-adrs-vtgiang-dotcom

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Record architectural decisions and context to preserve rationale for future engineers.

Core Features & Use Cases

  • ADRs to capture decisions, trade-offs, and alternatives with a consistent template stored under docs/decisions/.
  • Inline guidance for documenting known gotchas, API changes, and governance practices so agents understand historical context.
  • Lifecycle awareness including proposed, accepted, superseded, and deprecated statuses to trace evolution.

Quick Start

Create ADR-001 detailing a major architectural decision and place it under docs/decisions/ with a concise context and 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 document architectural decisions to preserve context for future engineers?▼

Architectural decision records capture design context, trade-offs, and alternatives using a consistent template. You apply this to significant API changes and feature releases, storing the history under docs/decisions/ to ensure rationale remains accessible.

When should I write an ADR for software engineering changes?▼

Write an ADR whenever you make significant design decisions, API changes, or feature releases. Recording architectural decisions enforces consistent rationale and helps future engineers understand the historical context and governance practices.

How do I track the lifecycle of an architecture decision record?▼

Architecture decision records use lifecycle statuses including proposed, accepted, superseded, and deprecated. Tracking these states traces the evolution of design decisions and maintains accurate governance history over time.

Can I integrate architectural documentation with agent guidance files?▼

Yes, architectural documentation integrates with agent documentation goals by providing inline guidance. It updates files like CLAUDE.md and known gotchas so agents understand historical context and API changes.

What is the best way to structure ADR templates for engineering teams?▼

The best way to structure ADR templates is to enforce a consistent format capturing context, decisions, and alternatives. Store these records under docs/decisions/ to maintain a standardized architectural decision history.

Related Skills

Explore More Software Engineering Skills→
samjhechtsamjhecht
4

initialize-governance

Generate Constitution, Roadmap, and process documentation templates for project governance.

Community
Advanced
AgentientAgentient
2

architectural-decision-records

Automate architectural decision documentation with standard ADR templates and lifecycle statuses.

Official
Intermediate
sasamukusasamuku
8

review-pr

Automate pull request reviews with parallel multi-agent analysis and inline GitHub comments.

Community
Advanced
AskTinNguyenAskTinNguyen

documentation-and-adrs

Capture architectural decisions with ADR templates and lifecycle guidance.

Community
Intermediate