create-architecture-documentation

Generate C4 or arc42 architecture documentation from codebases and existing documentation.

Updated Aug 17, 2024
One-click install
npx skills add https://github.com/LinoWhy/.dotfiles --skill create-architecture-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-architecture-documentation
Source: https://github.com/LinoWhy/.dotfiles/tree/main/agents/.agents/local-skills/create-architecture-documentation
Command: npx skills add https://github.com/LinoWhy/.dotfiles --skill create-architecture-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

## What problem does it solve? Generates structured architecture documentation from existing codebase and documents, enabling consistent system design artifacts.

## Core Features & Use Cases

  • Framework-agnostic architecture documentation with options for C4, arc42, or ADR templates.
  • Grounded in code and docs by analyzing project structure, dependencies, and deployment configs.
  • Output-ready artifacts including diagrams, ADR scaffolding, and narrative descriptions for system context, components, data flow, and deployment.

### Quick Start Ask me to generate architecture documentation for the current project, choosing a framework (C4, arc42, ADR) if you have a preference.

Frequently Asked Questions about create-architecture-documentation

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

FAQPage Schema
How do I generate architecture documentation from an existing codebase?

To generate architecture documentation from a codebase, the Skill analyzes project structures, dependencies, and deployment configs to produce grounded system design artifacts like diagrams and narrative descriptions.

What is the difference between C4 and arc42 documentation formats?

C4 and arc42 are both supported formats for structuring architecture documentation. C4 focuses on visual system context and component diagrams, while arc42 provides a comprehensive template for system design notes and narrative.

How do I create an Architecture Decision Record (ADR) from existing project configs?

You can create ADR scaffolding by applying the Skill to your repository, which collects root configs and API definitions to generate ready-to-use ADR templates alongside your architecture documentation.

Can I generate deployment diagrams from API definitions automatically?

Yes, the Skill generates deployment diagrams by analyzing your existing API definitions and deployment configs within the codebase, producing output-ready visual artifacts for your architecture.

Does this architecture documentation tool work without specific framework dependencies?

Yes, the architecture documentation generation is framework-agnostic, allowing you to generate C4, arc42, or ADR artifacts without being locked into specific software engineering frameworks.

What is the best way to document system context and data flow for a software project?

The best way to document system context and data flow is using a grounded tool that analyzes your actual codebase to produce structured C4 or arc42 diagrams and narrative descriptions.