How bflorat/architecture-document-template works
Project type and purpose
• This is not a runtime application but a documentation‐generation template repository.
File structure
• Top level:
• README.adoc / README.md / LICENSE.md – project overview, principles, license
• view-*.adoc and glossary.adoc – example Asciidoc files for each architecture view (application, development, sizing, infrastructure, security) and glossary
• blank-template/ – skeletal versions of the same Asciidoc files plus an export script (in export/) and sample resources
• export script (blank-template/export) – drives conversion of Asciidoc + PlantUML into target formats
README for additional insights
• Describes five self-contained architecture views, each divided into Constraints, NFR, Solution
• Specifies the use of Asciidoc, export tooling, PlantUML with C4 customization
• Encourages a “living documentation” workflow using Git
Diagramming recommendations
• “Asciidoc + .puml → Export Script → Asciidoctor & PlantUML → PDF/HTML”
• “Git commit → CI pipeline → generated artifacts”
• Blue for source modules (Asciidoc files, templates)
• Green for toolchain components (Asciidoctor, PlantUML, script)
• Yellow for outputs (PDF, HTML, ODT)
• Grey for external services (GitHub CI)