ba-sequence-spec

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.

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.

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.

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.

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.

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.