skills.rest
cyalcala
cyalcalaCOMMUNITY
Explore all skills by this author →
GitHub

documentation-and-adrs

Record architectural decisions with ADR templates and inline context.

1|Updated Mar 17, 2026
Search Tags:#architecture#documentation#adr#docs#guidelines#decision-record
One-click install
npx skills add https://github.com/cyalcala/va-freelance-hub --skill documentation-and-adrs-cyalcala
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/cyalcala/va-freelance-hub/tree/main/.antigravity/skills_old_tainted/documentation-and-adrs
Command: npx skills add https://github.com/cyalcala/va-freelance-hub --skill documentation-and-adrs-cyalcala

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams record the rationale behind architectural decisions, API changes, and important context to guide future engineers and agents.

Core Features & Use Cases

  • Architecture Decision Records (ADRs) capture the reasoning behind major choices, including constraints, trade-offs, and alternatives.
  • Inline documentation practices and lifecycle guidance help onboard new team members and agents to the project standards.
  • Use Case: When shipping a new feature, create or update ADRs to document the decision context and expected outcomes.

Quick Start

Create a new ADR documenting a major architectural decision and commit it to docs/decisions/

Frequently Asked Questions about documentation-and-adrs

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

FAQPage Schema
What is an Architecture Decision Record and when do I need to write one?▼

An Architecture Decision Record (ADR) captures the rationale, constraints, and alternatives behind a major software design choice. You need an ADR when making auditable architectural decisions, API changes, or project standards across teams to guide future engineers.

How do I document architectural decisions and design rationale for my software project?▼

You document architectural decisions by applying enforced ADR templates that log the decision context, trade-offs, and alternatives. This skill records the rationale inline and commits the decision logs to your project's docs to guide future engineers and onboarding agents.

Can I use this skill to document public API changes and context for cross-team projects?▼

Yes, you can use this skill to document public API changes across teams. It records the design choices and inline context to explain constraints, ensuring auditable decisions for software projects of any size.

What's the best way to onboard new team members to project architecture standards?▼

The best way to onboard new members is using inline documentation practices and lifecycle guidance. This skill captures architectural decisions and rationale, providing the context needed to explain project standards to new engineers and agents.

Does this skill enforce ADR templates and decision logging formats?▼

Yes, this skill enforces ADR templates and decision logging. It applies structured formats to capture constraints, alternatives, and expected outcomes, ensuring your architectural decisions are auditable and consistently documented.

Related Skills

Explore More Content & Communication Skills→
Fr-e-dFr-e-d
157

architecture-extract

Analyze project directory structures to generate architectural summaries.

Community
Basic
686f6c61686f6c61
105

write-adr

Generate Architecture Decision Records documenting context, alternatives, decision, and consequences.

Community
Intermediate
staticWagomUstaticWagomU
6

git-commit

Stage meaningful code changes and generate rationale-focused commit messages.

Community
Intermediate
ofelixdevofelixdev

architecture

Facilitate architectural decisions with ADR documentation and trade-off analysis.

Community
Intermediate