skills.rest
richardnguyen0715
richardnguyen0715COMMUNITY
Explore all skills by this author →
GitHub

documentation-and-adrs

Create Architecture Decision Records for database migration decisions.

Updated May 20, 2026
Search Tags:#architecture#software development#ADR#code documentation#decision documentation
One-click install
npx skills add https://github.com/richardnguyen0715/ai-chatting-app --skill documentation-and-adrs-richardnguyen0715
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/richardnguyen0715/ai-chatting-app/tree/main/.github/skills/documentation-and-adrs
Command: npx skills add https://github.com/richardnguyen0715/ai-chatting-app --skill documentation-and-adrs-richardnguyen0715

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill helps teams to effectively document and record architectural decisions, improving codebase understanding and collaboration.

Core Features & Use Cases

  • Decision Documentation: Facilitates recording architectural decisions, providing a rationale and alternatives considered.
  • ADRs: Capture the reasoning behind significant technical decisions, improving maintainability and decision-making.
  • Inline Documentation: Offers guidelines for commenting and documentation best practices to enhance code readability.
  • API Documentation: Provides templates and examples for API documentation to maintain a high standard of developer clarity.

Quick Start

Use the documentation-and-adrs skill to create a new Architecture Decision Record (ADR) for a recent database migration 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 write an Architecture Decision Record for a database migration?▼

Architecture Decision Records (ADRs) capture the reasoning behind significant technical decisions, providing rationale and alternatives considered. They are needed to improve codebase understanding and maintainability during ongoing software development.

What's the best way to document code rationale and alternatives considered?▼

Architecture Decision Records (ADRs) capture the reasoning behind significant technical decisions, providing rationale and alternatives considered. They are needed to improve codebase understanding and maintainability during ongoing software development.

Does this approach help with inline code comments and API documentation?▼

Architecture Decision Records (ADRs) capture the reasoning behind significant technical decisions, providing rationale and alternatives considered. They are needed to improve codebase understanding and maintainability during ongoing software development.

When do I need formal decision documentation in software engineering?▼

Architecture Decision Records (ADRs) capture the reasoning behind significant technical decisions, providing rationale and alternatives considered. They are needed to improve codebase understanding and maintainability during ongoing software development.

Can I use ADRs to improve codebase understanding and team collaboration?▼

Architecture Decision Records (ADRs) capture the reasoning behind significant technical decisions, providing rationale and alternatives considered. They are needed to improve codebase understanding and maintainability during ongoing software development.

Related Skills

Explore More Software Engineering Skills→
mattgierhartmattgierhart
193

prd-v06-architecture-design

Translate stack decisions and constraints into coherent system architecture with ARC- entries.

Community
Advanced
wildbitcawildbitca
1

common-documentation

Standardize code comments, READMEs, and technical documentation practices.

Official
Basic
Ab-aswiniAb-aswini
2

architecture

Analyze requirements, evaluate trade-offs, and document architectural decisions with ADRs.

Community
Intermediate
deandumdeandum
3

documentation

Write ADRs, READMEs, and inline comments to preserve design intent.

Community
Intermediate