Mermaid is a JavaScript-based diagramming and charting tool that turns text-based definitions into diagrams. Its plain-text syntax fits Markdown, wikis, and documentation tools, making diagrams easy to generate alongside architectural discussion. section 3.3
Use Mermaid to make an application's architecture visible: model components, their interactions, class relationships, and system boundaries. It supports flowcharts, sequence diagrams, class diagrams, state diagrams, and C4 views. section 3.3 section 3.4
Iterate on an IT asset-management class model
Start with a Python ITAM system using FastAPI, SQLAlchemy, and hexagonal architecture. Request a Mermaid class diagram, then refine it by adding Asset as Hardware’s parent, moving funding details into FundingDetails, and introducing a DepreciationStrategy interface with concrete implementations. The resulting relationship view can show inheritance, containment, uses, and implementation links. section 3.3
|
|
I would like to build an ITAM project written in Python. It will focus on the tracking and management of Hardware. It should expose REST APIs, using FastAPI, and persist data using SQLAlchemy. It should use hexagonal architecture. As a software architect, please show me the Mermaid class diagram for this project." |
A focused prompt supplies the domain, language, frameworks, persistence layer, and architectural pattern needed to request a first Mermaid class diagram. section 3.3
Mermaid can also express a C4 progression: context diagrams show interactions inside and outside the system; container diagrams show components and relationships; component and code diagrams provide increasingly detailed views. Pair diagram generation with explicit requirements, because stated choices such as FastAPI, SQLAlchemy, and hexagonal architecture shape the proposed design. section 3.3 section 3.3
