usecase-overview-generator

Generate a consolidated UC-00 use case overview document from individual module use case files.

Updated Aug 15, 2026
One-click install
npx skills add https://github.com/jacksonlee-tw/mystock-vue --skill usecase-overview-generator-jacksonlee-tw
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: usecase-overview-generator
Source: https://github.com/jacksonlee-tw/mystock-vue/tree/main/mystock-analysis/.github/skills/usecase-overview-generator
Command: npx skills add https://github.com/jacksonlee-tw/mystock-vue --skill usecase-overview-generator-jacksonlee-tw

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve? Maintaining a system-wide use case overview by hand is error-prone and quickly becomes outdated as individual module documents change. This Skill scans all use case documents under docs/use-cases and automatically compiles a single UC-00 overview file with actor tables, Mermaid diagrams, business classifications, and statistics. ## Core Features & Use Cases - Automated Aggregation: Scans every UC-*.md file, extracts module names, actors, and use case tables, and merges them into one overview document. - Mermaid 11.x-Safe Diagrams: Generates flowchart LR based use case diagrams and sequenceDiagram flows, strictly avoiding unsupported PlantUML-style usecase syntax. - Structured Output Template: Produces role summary tables, business domain classifications, detailed per-module UC lists, statistics, and cross-links using a fixed template. - Use Case: After adding a new module document like UC-arrivePlant-廠門地磅作業.md, ask the assistant to regenerate the overview and receive an updated UC-00-使用案例總覽.md with the new module included in every table and diagram. ## Quick Start Ask the assistant to regenerate the UC-00 use case overview from all documents in docs/use-cases.

Frequently Asked Questions about usecase-overview-generator

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

FAQPage Schema
How do I generate a use case overview document from multiple Markdown files?▼

Invoke this Skill and it scans all UC-*.md files under docs/use-cases, excluding UC-00 itself, then compiles actors, use case tables, and module classifications into a single UC-00-使用案例總覽.md following the bundled template.

Does Mermaid support UML use case diagrams?▼

No, Mermaid 11.x does not support usecase or usecaseDiagram syntax. This Skill simulates use case diagrams with flowchart LR, using stadium shapes for actors, rounded rectangles for use cases, subgraphs for grouping, and labeled dashed arrows for include and extend relationships.

How to draw include and extend relationships in Mermaid flowchart?▼

Use the labeled dashed arrow syntax A -. "include" .-> B or A -. "extend" .-> B. The quotes around the label and the spaces around the arrow segments are required for the label to render correctly.

Why does my Mermaid diagram fail with actor or usecase keywords?▼

Those keywords come from PlantUML and are not valid Mermaid syntax, so the diagram fails to parse. Replace them with flowchart LR node definitions such as OPR(["name"]) for actors and UC01("name") for use cases.

What output does the use case overview generation produce?▼

It writes docs/use-cases/UC-00-使用案例總覽.md containing a system overview, actor summary table, Mermaid flowchart and sequence diagrams, business domain classification, per-module use case lists, statistics, and relative links to each module document, all in Traditional Chinese.