ba-sequence-spec

Name: ba-sequence-spec
Availability: InStock
Author: yukine5377

Generate Mermaid sequence diagrams and API specifications from UI specifications and user flows.

Updated Apr 12, 2026

Search Tags:#documentation #mermaid #draft #business-analysis #sequence-diagram #api-specification #ui-flow

Ready to run

npx skills add https://github.com/Yukine5377/common --skill ba-sequence-spec

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: ba-sequence-spec
Source: https://github.com/Yukine5377/common/tree/main/.cursor/skills/ba-sequence-spec
Command: npx skills add https://github.com/Yukine5377/common --skill ba-sequence-spec

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python-docx, and includes scripts (resource) components.

What problem does it solve?

This Skill helps business analysts automatically generate sequence diagrams and detailed API specifications from UI specifications and user flow, promoting consistency and faster documentation.

Core Features & Use Cases

Derive Mermaid sequence diagrams (User–FE–BE–Partner) from UI specs and screen flows
Produce API specifications including Request/Response/Error and Status Codes
Create a draft and a main Markdown document; optionally export to Word using a script
Iterate with guided inputs (screen lists, user flow descriptions, ERD) and confirm data before rendering

Quick Start

Provide the necessary screens list, user flow description, and ERD to auto generate the initial sequence diagram and API specs.

Frequently Asked Questions about ba-sequence-spec

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

FAQPage Schema

How do I generate sequence diagrams from UI flows and user specifications?▼

To generate sequence diagrams from UI flows, provide the screen list, user flow description, and ERD. The tool outputs a main Markdown file containing Mermaid sequence diagrams and API specification sections.

Can I automatically create API specifications from a UI specification?▼

Yes, you can create API specifications from a UI specification. The process derives Request, Response, Error, and Status Code details directly from the screen list and user flow data you provide.

What do I need to prepare to start generating Mermaid sequence diagrams for business analysis?▼

You need a structured screen list, a user flow description, and an ERD to start generating Mermaid sequence diagrams. These guided inputs ensure data is confirmed before rendering the documentation draft.

Does the generated sequence diagram documentation support export to Word?▼

Yes, the generated documentation supports export to Word. A script uses the python-docx dependency to convert the main Markdown file and Mermaid diagrams into a Word document format.

How are partner interactions represented in the generated sequence diagrams?▼

Partner interactions are represented in the generated sequence diagrams using a User–FE–BE–Partner structure. This Mermaid syntax applies across use cases with multiple screens to map external interactions.

What is the best way to document API specs and user flows for multiple screens?▼

The best way to document API specs and user flows is by iterating with guided inputs. Confirming data before rendering ensures the generated Markdown accurately captures multi-screen use cases and partner interactions.