Does it follow a specific naming convention?

Yes, it uses a 4-digit sequence followed by a short English summary, such as 0003-tts-engine-abstraction.md.

Can I include implementation details or code snippets?

The skill is designed to capture high-level architectural facts and decisions; it specifically avoids implementation details or code fragments to keep the documentation focused.

What sections are included in the generated ADR?

The generated Markdown includes sections for Title, Context (background/problems), Decision (chosen solution), Consequences (pros/cons), and Alternatives.

Where does this skill save the ADR files?

All ADR files are automatically saved to the docs/adr/ directory in your project repository for centralized access.

Does it handle existing ADRs?

Yes, the skill scans existing files to determine the next logical sequence number and checks for contradictions with previous decisions.

ADR Writer

Name: ADR Writer
Author: Hakuya5247

byHakuya5247

0•

学习与文档

Generates and manages Architecture Decision Records (ADRs) to track key design choices within a standardized documentation workflow.

The adr-writer skill automates the process of documenting significant architectural decisions within a software project by enforcing a standardized format and storage location in the docs/adr/ directory. It ensures team alignment by capturing the context, decision rationale, and potential consequences of design choices, while maintaining a clear, chronological history through sequential file naming. This tool is essential for long-term project maintainability, helping teams understand the 'why' behind specific technical paths and preventing the loss of institutional knowledge as the codebase evolves.

主要功能

01Automatic sequential file numbering for chronological tracking

02Standardized ADR creation using structured Markdown templates

03Centralized storage management within docs/adr/

040 GitHub stars

05Requirement-based sections for Context, Decision, and Consequences

06Consistency validation against existing architectural records

使用场景

01Tracking historical context for major infrastructure or database changes

02Recording the rationale for specific API design patterns

03Documenting the transition to a new framework or library

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hakuya5247/yomicord adr-writer

For use in Claude.ai and ChatGPT

Download Skill