documentation-and-adrs

Automate creation and management of ADRs and project documentation.

Updated Apr 30, 2026

Search Tags:#architecture #markdown #decision record #adr #project documentation

Ready to run

npx skills add https://github.com/acme-skunkworks/markdownlint-config --skill documentation-and-adrs-acme-skunkworks

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/acme-skunkworks/markdownlint-config/tree/main/.agents/skills/documentation-and-adrs
Command: npx skills add https://github.com/acme-skunkworks/markdownlint-config --skill documentation-and-adrs-acme-skunkworks

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the process of documenting architectural decisions, architectural decision records (ADRs), and other project documentation, reducing the time spent on documentation and ensuring consistency.

Core Features & Use Cases

ADRs: Capture the rationale behind significant technical decisions.
Documentation: Create project documentation that includes code, architecture, and ADRs.
Use Case: Automate the generation of project READMEs, API documentation, and other documentation required for project understanding and maintenance.

Quick Start

Use the documentation-and-adrs skill to generate a project README.

Frequently Asked Questions about documentation-and-adrs

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

FAQPage Schema

How do I automate architectural decision records to capture decision rationales?▼

You can automate architectural decision records by using structured Markdown and JSON templates to capture decision rationales, project overviews, and API specifications, ensuring consistency while reducing manual documentation time.

What is the best way to generate project documentation and ADRs automatically?▼

The best way to generate project documentation and ADRs is to use an automation skill that creates project READMEs and API documentation through structured templates, capturing technical decisions and architecture overviews systematically.

Can I use Markdown and JSON templates for structured project documentation?▼

Yes, you can use Markdown and JSON templates for structured project documentation. This approach supports the creation of project overviews, API specifications, and architectural decision records in a consistent, machine-readable format.

Does this ADR automation tool support API specifications and project overviews?▼

Yes, this ADR automation tool supports API specifications and project overviews. It captures decision rationales and automates the generation of READMEs and other documentation required for project understanding and maintenance.

Why do I need architectural decision records in my software engineering workflow?▼

You need architectural decision records to capture the rationale behind significant technical decisions. ADRs ensure that project documentation maintains a historical context of architecture choices, reducing onboarding time and preventing knowledge loss.

What are the limitations of automating project documentation with templates?▼

Automating project documentation with templates requires consistent human input to capture accurate decision rationales. While templates structure output for ADRs and API specifications, they cannot independently evaluate the technical validity of the architectural decisions documented.