doc-sys

Generate system architecture documentation with Mermaid diagrams from a codebase.

Updated Mar 19, 2026
One-click install
npx skills add https://github.com/sunLeee/optimization --skill doc-sys-sunleee
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-sys
Source: https://github.com/sunLeee/optimization/tree/main/.claude/skills/scaffolding/docs/doc-sys
Command: npx skills add https://github.com/sunLeee/optimization --skill doc-sys-sunleee

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the generation of system architecture documents from a codebase, reducing manual effort and ensuring consistent architectural records.

Core Features & Use Cases

  • Automated project analysis to identify modules, layers, and dependencies.
  • Mermaid diagrams generation for component and sequence diagrams to visualize architecture.
  • Structured documentation output with sections for overview, architecture overview, layers, data flows, and tech stack.

Quick Start

Generate the architecture document at docs/architecture/system.md for the current codebase, or specify a custom path using the argument-hint.

Frequently Asked Questions about doc-sys

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

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

Generate system architecture documentation by analyzing your codebase's directory structure, dependencies, and component interactions. The tool produces structured sections for layers, data flows, and the tech stack, outputting to a markdown file.

Can I automatically create Mermaid diagrams for component and sequence interactions?

Yes, you can automatically create Mermaid diagrams for component and sequence interactions. The Skill analyzes your codebase to identify modules and data flows, then generates corresponding Mermaid diagrams to visualize the architecture.

What is the best way to document layers and data flows for medium-to-large projects?

The best way to document layers and data flows for medium-to-large projects is using automated codebase analysis. This approach identifies modules and dependencies to produce structured architectural records with visual diagrams.

Does this architecture generation approach work for small codebases?

This architecture generation approach is designed for medium-to-large projects. It analyzes complex directory structures, dependencies, and component interactions, which may be excessive for small codebases with minimal architectural layers.

How do I specify a custom output path for the generated architecture markdown file?

You specify a custom output path for the generated architecture markdown file using the argument-hint. By default, the tool generates the document at docs/architecture/system.md, but you can override this path.

Why use automated codebase analysis instead of writing system architecture docs manually?

Use automated codebase analysis to reduce manual effort and ensure consistent architectural records. It systematically extracts directory structures and dependencies to generate uniform documentation and Mermaid diagrams.