How does this skill find related ADRs?

The skill scans the docs/decisions/ directory associated with your target path to identify existing Architecture Decision Records for automatic cross-referencing.

Where are the templates for the documents stored?

The skill typically looks for a template located at templates/architecture.md within your repository to ensure consistent styling.

Can I create documents for specific sub-modules?

Yes, you can use the --module flag to target a specific directory, or the --root flag to place documentation at the repository root.

What is the difference between an ADR and an Architecture Doc?

ADRs record the 'why' behind specific decisions at a point in time, while Architecture Docs describe the 'what' and 'how' of the current system design as a living document.

New Architecture Doc

Name: New Architecture Doc
Author: alexnodeland

byalexnodeland

•

学习与文档

Generates comprehensive system architecture documentation and links related Architecture Decision Records for streamlined engineering onboarding.

The New Architecture Doc skill automates the creation of high-level system design documents by scanning your repository for existing Architectural Decision Records (ADRs) and relevant context. It ensures technical documentation remains consistent and cross-referenced, providing a clear map of components, data flows, and design patterns. This is particularly useful for teams practicing specification-driven development who need to maintain living documentation to align stakeholders and reduce the cognitive load for new engineers joining a project.

主要功能

01Support for both repository-level and module-specific documentation paths

02Standardized formatting for high-level system design and data flow diagrams

033 GitHub stars

04Automated document scaffolding from standardized architecture templates

05Automatic frontmatter population including titles, dates, and decision links

06Intelligent scanning and cross-referencing of related ADRs in the codebase

使用场景

01Maintaining a single source of truth for high-level design that evolves alongside the codebase

02Documenting complex data flows or authentication systems within specific sub-modules

03Onboarding new engineers by providing a clear overview of system components and historical decisions

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add alexnodeland/principled new-architecture-doc

For use in Claude.ai and ChatGPT

Download Skill