adr-review

Analyze and refine Markdown Architecture Decision Records for clarity and maintainability.

47.5k|2.5k|Updated Jun 20, 2019
One-click install
npx skills add https://github.com/prisma/prisma --skill adr-review-prisma
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr-review
Source: https://github.com/prisma/prisma/tree/main/skills-contrib/adr-review
Command: npx skills add https://github.com/prisma/prisma --skill adr-review-prisma

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill addresses the common issue of Architecture Decision Records (ADRs) becoming stale, overly contextual, or difficult for new team members to understand by providing an objective, structural critique and rewrite.

Core Features & Use Cases

  • Narrative Analysis: Identifies buried decisions, missing context, and transient information that confuses future readers.
  • Structural Optimization: Enforces a clear, decision-first documentation format that prioritizes readability and long-term maintainability.
  • Use Case: Use this skill when onboarding new engineers to a project to ensure all historical architectural decisions are documented clearly and are free of outdated ticket references or project-specific jargon.

Quick Start

Ask the agent to review the architecture decision record located at docs/adr/001-database-migration.md and rewrite it for clarity.

Frequently Asked Questions about adr-review

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

FAQPage Schema
How do I review and improve the clarity of Architecture Decision Records?

To improve Architecture Decision Records, analyze the Markdown files to identify context gaps, remove transient project metadata, and restructure the content into a decision-first format. This ensures long-term maintainability and readability for future engineers.

Why do my ADRs become stale and hard for new engineers to understand?

ADRs become stale when they contain buried decisions, missing context, or transient project-specific jargon. An objective structural critique and rewrite can remove outdated ticket references and enforce a clear narrative flow for future-proof readability.

What is the best way to rewrite technical documentation for long-term maintainability?

The best way to rewrite technical documentation for maintainability is by enforcing a decision-first standard that prioritizes clear reasoning and alternative evaluation. This restructures content to remove transient metadata and clarify historical architectural decisions.

Can I use this to prepare architecture documentation for new team member onboarding?

Yes, you can use this to prepare architecture documentation for onboarding by analyzing and refining ADRs. It ensures all historical architectural decisions are documented clearly and are free of outdated ticket references or project-specific jargon.

Does this ADR review process work with standard Markdown files?

Yes, the ADR review process operates directly on Markdown-based ADR files. It analyzes the narrative flow and structural content to identify gaps and restructure the documentation without requiring additional file formats.

When should I not use an automated ADR refactoring approach?

You should not use an automated ADR refactoring approach when your documentation requires subjective historical context that defies a decision-first standard. The process strictly prioritizes clear reasoning and alternative evaluation over retaining transient project metadata.