plantuml

PlantUML Diagram Generation

Generate PlantUML diagrams for architecture, API flows, and process visualization using project branding.

Project Context — Read project-config.md in the repo root for brand tokens, color palette, and project metadata.

Brand Theme

Use this block at the start of your .puml files for consistent brand styling:

@startuml
skinparam backgroundColor #F8F9FA
skinparam defaultFontSize 14
skinparam defaultFontColor #1F2937
skinparam rectangle {
  BackgroundColor #FFF7ED
  BorderColor #F97316
  FontColor #1F2937
}
skinparam participant {
  BackgroundColor #F0F9FF
  BorderColor #0EA5E9
}
skinparam database {
  BackgroundColor #ECFDF5
  BorderColor #10B981
}
skinparam arrow {
  Color #1F2937
}
skinparam arrowColor #E10A0A
' Use arrowColor for key flows; Color for default
@enduml

For sequence diagrams, you can add:

skinparam sequenceArrowColor #E10A0A
skinparam sequenceLifeLineBorderColor #1F2937
skinparam sequenceParticipantBackgroundColor #F8F9FA
skinparam sequenceParticipantBorderColor #E10A0A

Standard Participants

When documenting systems, use consistent participant names where applicable:

Participant	Use case
Streamlit App	Streamlit dashboards
FastAPI	API services
SQL Server	Data layer
Redis / Cache	Caching layer
User	End user / operator

Example:

@startuml
actor User
participant "Streamlit App" as app
participant "FastAPI" as api
database "SQL Server" as db
User -> app : Request
app -> api : API call
api -> db : Query
db --> api : Result
api --> app : Response
app --> User : Display
@enduml

Diagram Types

Type	Best For
Sequence	API calls, request/response flows
Class	OOP design, data models
Component	System architecture, microservices
Activity	Workflows, business logic
State	State machines, lifecycles
Deployment	Infrastructure, network topology