Namespace C4.Net.Documentation
Classes
- Arc42DocumentationTemplate
An implementation of the arc42 documentation template (http://arc42.org) consisting of the following sections:
- Introduction and Goals (1)
- Constraints (2)
- Context and Scope (2)
- Solution Strategy (3)
- Building Block View (3)
- Runtime View (3)
- Deployment View (3)
- Crosscutting Concepts (3)
- Architectural Decisions (3)
- Quality Requirements (2)
- Risks and Technical Debt (4)
- Glossary (5)
The number in parentheses () represents the grouping, which is simply used to colour code section navigation buttons when rendered.
- Decision
Represents a single (architecture) decision, as described at http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions
- Documentation
Represents the documentation within a workspace - a collection of content in Markdown or AsciiDoc format, optionally with attached images.
See https://structurizr.com/help/documentation on the Structurizr website for more details.
- DocumentationTemplate
The superclass for all documentation templates.
- Image
Represents an image asset that can be embedded from workspace documentation.
- Section
Represents a single documentation section attached to the workspace or a model element.
- StructurizrDocumentationTemplate
A simple documentation template, based upon the "software guidebook" concept in Simon Brown's Software Architecture for Developers book, with the following sections:
- Context (1)
- Functional Overview (2)
- Quality Attributes (2)
- Constraints (2)
- Principles (2)
- Software Architecture (3)
- Containers (3)
- Components (3)
- Code (3)
- Data (3)
- Infrastructure Architecture (4)
- Deployment (4)
- Development Environment (4)
- Operation and Support (4)
- Decision Log (5)
The number in parentheses () represents the grouping, which is simply used to colour code section navigation buttons when rendered.
- ViewpointsAndPerspectivesDocumentation
An implementation of the "Viewpoints and Perspectives" documentation template (http://www.viewpoints-and-perspectives.info), from the "Software Systems Architecture" book by Nick Rozanski and Eoin Woods, consisting of the following sections:
- Introduction (1)
- Glossary (1)
- System Stakeholders and Requirements (2)
- Architectural Forces (2)
- Architectural Views (3)
- System Qualities (4)
- Appendices (5)
The number in parentheses () represents the grouping, which is simply used to colour code section navigation buttons when rendered.
Enums
- DecisionStatus
Represents the status of a decision.
- Format
Identifies the markup format used by a documentation section or decision.