In addition to diagrams, Structurizr lets you create supplementary documentation using the Markdown or AsciiDoc formats.
See https://structurizr.com/share/31/documentation for an example.
The documentation is broken up into a number of sections, as defined by the template you are using, the following of which are included:
You can add custom sections using the addSection
method on the DocumentationTemplate class:
template.addSection(softwareSystem, "My custom section", Format.Markdown, ...);
Images can be included using the regular Markdown/AsciiDoc syntax.
For this to work, the image files must be hosted externally (e.g. on your own web server, ideally accessible via HTTPS) or uploaded with your workspace using the addImages()
or addImage()
methods on the DocumentationTemplate class.
template.addImages(new File("..."));
See functional-overview.md and FinancialRiskSystem for an example.
Software architecture diagrams from your workspace can be embedded within the documentation sections using an additional special syntax.
The syntax is similar to that used for including images, for example:
Markdown - ![](embed:DiagramKey)
AsciiDoc - image::embed:DiagramKey[]
See context.md, context.adoc and FinancialRiskSystem for an example.