arch

Name: arch
Availability: InStock
Author: JamSuite

Generate or update ARCHITECTURE.md by analyzing the codebase.

1|1|Updated Feb 25, 2025

Search Tags:#architecture #documentation #system-design #mermaid-diagram #codebase-analysis #architecture-update #diff-update

Ready to run

npx skills add https://github.com/JamSuite/jim --skill arch-jamsuite

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: arch
Source: https://github.com/JamSuite/jim/tree/main/skills/arch
Command: npx skills add https://github.com/JamSuite/jim --skill arch-jamsuite

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) components.

What problem does it solve?

Generates or updates ARCHITECTURE.md by analyzing the actual codebase to reflect reality and detect drift. It ensures the architecture document aligns with the current code structure and decisions.

Core Features & Use Cases

Automatic generation and differential updates of ARCHITECTURE.md from the repository.
Optional integration of an upstream vision document to guide architecture storytelling and flag tensions.
Differential updates that preserve user edits while refreshing sections based on code findings.

Quick Start

Generate or refresh ARCHITECTURE.md for your project by invoking the arch skill on the target directory.

Frequently Asked Questions about arch

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

FAQPage Schema

How do I generate an ARCHITECTURE.md file from an existing codebase?▼

To generate an ARCHITECTURE.md file, this skill reads your repository structure and renders documentation using a standardized architecture template. It analyzes the actual code to establish an accurate architecture baseline automatically.

What is the best way to update architecture documentation when the codebase drifts?▼

Updating architecture documentation when codebase drift occurs requires differential updates that preserve user edits. This skill detects an existing ARCHITECTURE.md and refreshes only the affected sections based on current code findings.

Can I use a vision document to guide architecture documentation generation?▼

You can use a vision document to guide architecture documentation generation by optionally ingesting it into the analysis. This helps shape the architecture storytelling and flags tensions between the planned vision and actual code.

Does architecture documentation generation work for planning new features?▼

Architecture documentation generation does not work for planning features or implementing code. It is strictly designed to analyze the current codebase and synchronize the ARCHITECTURE.md file with your actual system design.

How do mermaid diagrams integrate with architecture documentation updates?▼

Mermaid diagrams integrate into architecture documentation updates by rendering the analyzed system design visually within the ARCHITECTURE.md file. The skill uses an architecture template to map codebase structures into these diagrams.