skills.rest
nguyenthienthanh
nguyenthienthanhCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation

Generate Markdown ADRs and Runbooks with standardized naming and validation.

24|3|Updated Nov 25, 2025
Search Tags:#project management#architecture#documentation#technical writing#operations#ADR#runbook
One-click install
npx skills add https://github.com/nguyenthienthanh/aura-frog --skill documentation-nguyenthienthanh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/nguyenthienthanh/aura-frog/tree/main/aura-frog/skills/documentation
Command: npx skills add https://github.com/nguyenthienthanh/aura-frog --skill documentation-nguyenthienthanh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintaining up-to-date and consistent project documentation, especially for critical architectural decisions (ADRs) and operational procedures (Runbooks), is often neglected. This Skill automates the creation of these essential documents, saving time and ensuring clarity.

Core Features & Use Cases

  • Architecture Decision Records (ADR): Generates structured ADRs for significant technical choices, documenting context, decisions, options, and consequences.
  • Operational Runbooks: Creates detailed runbooks for common operational tasks, incident response, and on-call handoff, including prerequisites, commands, and troubleshooting.
  • Templated & Standardized: Provides templates and naming conventions for both ADRs and Runbooks, ensuring consistency across your project documentation.
  • Use Case: After deciding to use PostgreSQL as the primary database for a new application, use this skill to generate an ADR documenting the context, decision, options considered, and consequences for future reference and team alignment.

Quick Start

Create an Architecture Decision Record for using PostgreSQL as the primary database

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I automate the creation of Architecture Decision Records for my project?▼

Architecture Decision Records (ADRs) document significant technical choices with context, decision rationale, options considered, and consequences. This Skill generates structured ADR templates with standardized naming and versioning to ensure consistency across your project and preserve decision history for team alignment.

What should I include in an operational runbook, and how do I create one?▼

Runbooks document operational procedures, incident response, and on-call handoffs with prerequisites, step-by-step commands, troubleshooting guidance, and references. This Skill automates runbook generation with templated sections to standardize procedures across your operations team.

Can I use this Skill to maintain consistent documentation standards across multiple services and teams?▼

Yes. The Skill enforces standardized naming conventions, versioning immutability, and templated formats for both ADRs and Runbooks, ensuring consistency across services, teams, and development lifecycles. Prerequisites and checklist validation prevent incomplete or non-compliant documentation.

How do ADRs and Runbooks differ, and when should I use each?▼

ADRs document architectural decisions and technology choices with long-term impact; Runbooks document operational procedures and incident response. Use ADRs to record why a technical choice was made (PostgreSQL as primary database); use Runbooks to capture how to execute procedures repeatably.

What happens if I need to update an ADR or Runbook after creation?▼

This Skill enforces versioning immutability for ADRs, preserving decision history and preventing retroactive changes that obscure why choices were made. New versions create separate records, maintaining an audit trail of evolving decisions and operational procedures.

Related Skills

Explore More Content & Communication Skills→
lidessenlidessen
3

engineering

Guide technical decisions with structured reasoning templates and validation criteria.

Community
Advanced
ArogyaReddyArogyaReddy

incident-runbook-templates

Create structured incident response runbooks with detection, triage, mitigation, resolution, and communication sections.

Community
Advanced
oborchersoborchers
28

architecture-decision-records

Create and manage Architecture Decision Records with status lifecycle and numbering.

Community
Advanced
Maccio-huangMaccio-huang

eng-runbook

Generate engineering runbooks with alerts, procedures, and incident checklists.

Community
Advanced