Help

The basics

• Getting started
• About
• Why use code?
• Visualise
• Document
• Explore
• Concepts
• Client libraries
• Workspaces
• Quick navigation
• Corporate branding
• Frequently Asked Questions (FAQ)
• Open source projects, academic establishments, and other non-profit organisations

Sharing, embedding and exporting

• Role-based access to workspaces
• Workspace sharing (public, shared, private)
• iframe diagram embed
• Image diagram embed
• Exporting diagrams
• Single HTML page export, for offline use

Software architecture

• The Art of Visualising Software Architecture
• The C4 software architecture model
• Model
• Views
• Is the software architecture model in the code?
• Components vs classes
• Extract and supplement

Data storage

• Security
• Client-side encryption

On-premises installation

• On-premises installation

Structurizr Express

• Structurizr Express
• Embedding Structurizr Express diagrams

Integrations

• Web API (JSON/HTTPS)
• Scripting API - Diagrams (JavaScript)
• Atlassian Confluence

Visualise

• Static structure diagrams
• Dynamic diagrams
• Deployment diagrams
• Shapes
• Notation
• Diagram key/legend
• Presentation mode
• Diagram navigation
• Diagram layout
• Keyboard shortcuts

Explore

• Explorations
• Static Structure - Tree
• Static Structure - Dendrogram
• Static Structure - Blocks
• Static Structure - Size - Circles
• Dependencies - All
• Dependencies - Containers
• Dependencies - Components
• Dependencies - Components and Code
• Code - Usage Count

Document

• Documentation overview
• Context
• Functional Overview
• Quality Attributes
• Constraints
• Principles
• Software Architecture
• Code
• Data
• Infrastructure Architecture
• Deployment
• Development Environment
• Operation and Support
• Usage
• Decision Log

Decision log

• Decision log (e.g. architecture decision records, ADRs)

Health checks

• HTTP-based health checks