What is an Architecture Decision Record (ADR)?

An ADR is a document that captures an important architectural decision, including the context, options considered, and the final consequences, helping teams understand the 'why' behind a system's design.

Is this skill part of a larger workflow?

Yes, it is a core component of the Aura Frog plugin, typically utilized during Phase 8 of its structured 9-phase development lifecycle.

Why should I use ADRs instead of just code comments?

ADRs provide high-level context and capture rejected alternatives that code comments usually miss, serving as a historical record for the evolution of the codebase.

How does this skill help with Runbooks?

It provides structured templates for service operations, health checks, and troubleshooting, ensuring that all operational commands are documented and ready for production use.

Can I use this for incident response?

Yes, the Runbook feature includes dedicated sections for alerts, escalation paths, and troubleshooting common issues to streamline incident management.

Aura Frog Documentation

Name: Aura Frog Documentation
Author: nguyenthienthanh

bynguyenthienthanh

•

학습 및 문서화

Generates structured Architecture Decision Records (ADRs) and operational Runbooks to maintain project history and system reliability.

This skill provides a standardized framework for capturing critical technical decisions and operational procedures within Claude Code. By automating the creation of ADRs and Runbooks, it ensures that architectural evolution is documented with clear trade-offs while providing copy-paste ready instructions for service maintenance, incident response, and troubleshooting. It is specifically designed to help teams avoid documentation debt by providing pre-defined templates and naming conventions that integrate seamlessly into a professional development workflow.

주요 기능

01Quality assurance checklists for both architectural and operational docs

021 GitHub stars

03Standardized ADR templates with status tracking and consequence mapping

04Operational Runbook generation for deployment and incident response

05Pre-configured naming conventions for documentation organization

06Actionable troubleshooting guides with ready-to-run terminal commands

사용 사례

01Creating step-by-step incident response procedures for on-call engineers

02Documenting technology stack transitions and architectural trade-offs using ADRs

03Standardizing technical handoff documentation during the final phases of development

주요 기능

01Quality assurance checklists for both architectural and operational docs

021 GitHub stars

03Standardized ADR templates with status tracking and consequence mapping

04Operational Runbook generation for deployment and incident response

05Pre-configured naming conventions for documentation organization

06Actionable troubleshooting guides with ready-to-run terminal commands

사용 사례

01Creating step-by-step incident response procedures for on-call engineers

02Documenting technology stack transitions and architectural trade-offs using ADRs

03Standardizing technical handoff documentation during the final phases of development