Does this skill read my entire codebase?

Yes, it explores the directory tree and key configuration files (like package.json or Cargo.toml) to ensure the generated documentation accurately reflects the current state of the project.

Is the generated documentation too technical for new developers?

No, it is specifically written for new contributors to help them understand where to make changes, keeping it high-level and accessible while remaining technical enough to be useful.

Why use ARCHITECTURE.md instead of a standard README?

While a README explains what a project does, ARCHITECTURE.md provides a mental map of where things are located and why the code is structured a certain way, specifically for contributors.

Can I customize the format of the generated document?

Yes, the skill follows rules defined in references/guidelines.md within your project, allowing you to tailor the output to your team's specific documentation standards.

Architecture.md Generator

Name: Architecture.md Generator
Author: pruett

bypruett

•

学习与文档

Generates high-level architectural overview documents that help contributors navigate and understand complex codebases.

The Architecture.md Generator automates the creation and maintenance of ARCHITECTURE.md files, providing a high-value mental map for developers. By exploring the project root, directory structures, and entry points, it identifies top-level modules and data flows to explain where changes should be made rather than internal implementation details. It adheres to strict guidelines to keep documentation concise, up-to-date, and focused on architectural invariants that aid onboarding and long-term project maintenance.

主要功能

01Integrates project-specific guidelines from local reference files

02Focuses on architectural invariants and where to implement specific features

03Identifies key modules, data flows, and layer boundaries automatically

04Performs deep codebase exploration to build an accurate mental model

05Generates concise, under-300-line documentation for maximum readability

068 GitHub stars

使用场景

01Onboarding new contributors by providing a clear entry point to the project structure

02Updating outdated architecture summaries after major refactors or reorganizations

03Documenting high-level design decisions and architectural boundaries during a build

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add pruett/dotfiles architecture-md

For use in Claude.ai and ChatGPT

Download Skill