Class Arc42DocumentationTemplate
- Namespace
- C4.Net.Documentation
- Assembly
- C4.Net.Core.dll
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.
public class Arc42DocumentationTemplate : DocumentationTemplate- Inheritance
-
Arc42DocumentationTemplate
- Inherited Members
Constructors
Arc42DocumentationTemplate(Workspace)
Creates the arc42 template helper for a workspace.
public Arc42DocumentationTemplate(Workspace workspace)Parameters
workspaceWorkspaceThe workspace whose documentation will be populated.
Methods
AddArchitecturalDecisionsSection(SoftwareSystem, Format, string)
Adds an "Architectural Decisions" section relating to a SoftwareSystem.
public Section AddArchitecturalDecisionsSection(SoftwareSystem softwareSystem, Format format, string content)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
formatFormatthe format of the documentation content
contentstringa string containing the documentation content
Returns
- Section
a documentation Section
AddArchitecturalDecisionsSection(SoftwareSystem, params FileSystemInfo[])
Adds an "Architectural Decisions" section relating to a SoftwareSystem from a file.
public Section AddArchitecturalDecisionsSection(SoftwareSystem softwareSystem, params FileSystemInfo[] files)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
filesFileSystemInfo[]one or more FileSystemInfo objects that point to the documentation content
Returns
- Section
a documentation Section
AddBuildingBlockViewSection(SoftwareSystem, Format, string)
Adds a "Building Block View" section relating to a SoftwareSystem.
public Section AddBuildingBlockViewSection(SoftwareSystem softwareSystem, Format format, string content)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
formatFormatthe format of the documentation content
contentstringa string containing the documentation content
Returns
- Section
a documentation Section
AddBuildingBlockViewSection(SoftwareSystem, params FileSystemInfo[])
Adds a "Building Block View" section relating to a SoftwareSystem from a file.
public Section AddBuildingBlockViewSection(SoftwareSystem softwareSystem, params FileSystemInfo[] files)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
filesFileSystemInfo[]one or more FileSystemInfo objects that point to the documentation content
Returns
- Section
a documentation Section
AddConstraintsSection(SoftwareSystem, Format, string)
Adds a "Constraints" section relating to a SoftwareSystem.
public Section AddConstraintsSection(SoftwareSystem softwareSystem, Format format, string content)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
formatFormatthe format of the documentation content
contentstringa string containing the documentation content
Returns
- Section
a documentation Section
AddConstraintsSection(SoftwareSystem, params FileSystemInfo[])
Adds a "Constraints" section relating to a SoftwareSystem from a file.
public Section AddConstraintsSection(SoftwareSystem softwareSystem, params FileSystemInfo[] files)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
filesFileSystemInfo[]one or more FileSystemInfo objects that point to the documentation content
Returns
- Section
a documentation Section
AddContextAndScopeSection(SoftwareSystem, Format, string)
Adds a "Context and Scope" section relating to a SoftwareSystem.
public Section AddContextAndScopeSection(SoftwareSystem softwareSystem, Format format, string content)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
formatFormatthe format of the documentation content
contentstringa string containing the documentation content
Returns
- Section
a documentation Section
AddContextAndScopeSection(SoftwareSystem, params FileSystemInfo[])
Adds a "Context and Scope" section relating to a SoftwareSystem from a file.
public Section AddContextAndScopeSection(SoftwareSystem softwareSystem, params FileSystemInfo[] files)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
filesFileSystemInfo[]one or more FileSystemInfo objects that point to the documentation content
Returns
- Section
a documentation Section
AddCrosscuttingConceptsSection(SoftwareSystem, Format, string)
Adds a "Crosscutting Concepts" section relating to a SoftwareSystem.
public Section AddCrosscuttingConceptsSection(SoftwareSystem softwareSystem, Format format, string content)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
formatFormatthe format of the documentation content
contentstringa string containing the documentation content
Returns
- Section
a documentation Section
AddCrosscuttingConceptsSection(SoftwareSystem, params FileSystemInfo[])
Adds a "Crosscutting Concepts" section relating to a SoftwareSystem from a file.
public Section AddCrosscuttingConceptsSection(SoftwareSystem softwareSystem, params FileSystemInfo[] files)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
filesFileSystemInfo[]one or more FileSystemInfo objects that point to the documentation content
Returns
- Section
a documentation Section
AddDeploymentViewSection(SoftwareSystem, Format, string)
Adds a "Deployment View" section relating to a SoftwareSystem.
public Section AddDeploymentViewSection(SoftwareSystem softwareSystem, Format format, string content)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
formatFormatthe format of the documentation content
contentstringa string containing the documentation content
Returns
- Section
a documentation Section
AddDeploymentViewSection(SoftwareSystem, params FileSystemInfo[])
Adds a "Deployment View" section relating to a SoftwareSystem from a file.
public Section AddDeploymentViewSection(SoftwareSystem softwareSystem, params FileSystemInfo[] files)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
filesFileSystemInfo[]one or more FileSystemInfo objects that point to the documentation content
Returns
- Section
a documentation Section
AddGlossarySection(SoftwareSystem, Format, string)
Adds a "Glossary" section relating to a SoftwareSystem.
public Section AddGlossarySection(SoftwareSystem softwareSystem, Format format, string content)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
formatFormatthe format of the documentation content
contentstringa string containing the documentation content
Returns
- Section
a documentation Section
AddGlossarySection(SoftwareSystem, params FileSystemInfo[])
Adds a "Glossary" section relating to a SoftwareSystem from a file.
public Section AddGlossarySection(SoftwareSystem softwareSystem, params FileSystemInfo[] files)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
filesFileSystemInfo[]one or more FileSystemInfo objects that point to the documentation content
Returns
- Section
a documentation Section
AddIntroductionAndGoalsSection(SoftwareSystem, Format, string)
Adds an "Introduction and Goals" section relating to a SoftwareSystem.
public Section AddIntroductionAndGoalsSection(SoftwareSystem softwareSystem, Format format, string content)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
formatFormatthe format of the documentation content
contentstringa string containing the documentation content
Returns
- Section
a documentation Section
AddIntroductionAndGoalsSection(SoftwareSystem, params FileSystemInfo[])
Adds an "Introduction and Goals" section relating to a SoftwareSystem from a file.
public Section AddIntroductionAndGoalsSection(SoftwareSystem softwareSystem, params FileSystemInfo[] files)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
filesFileSystemInfo[]one or more FileSystemInfo objects that point to the documentation content
Returns
- Section
a documentation Section
AddQualityRequirementsSection(SoftwareSystem, Format, string)
Adds a "Quality Requirements" section relating to a SoftwareSystem.
public Section AddQualityRequirementsSection(SoftwareSystem softwareSystem, Format format, string content)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
formatFormatthe format of the documentation content
contentstringa string containing the documentation content
Returns
- Section
a documentation Section
AddQualityRequirementsSection(SoftwareSystem, params FileSystemInfo[])
Adds a "Quality Requirements" section relating to a SoftwareSystem from a file.
public Section AddQualityRequirementsSection(SoftwareSystem softwareSystem, params FileSystemInfo[] files)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
filesFileSystemInfo[]one or more FileSystemInfo objects that point to the documentation content
Returns
- Section
a documentation Section
AddRisksAndTechnicalDebtSection(SoftwareSystem, Format, string)
Adds a "Risks and Technical Debt" section relating to a SoftwareSystem.
public Section AddRisksAndTechnicalDebtSection(SoftwareSystem softwareSystem, Format format, string content)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
formatFormatthe format of the documentation content
contentstringa string containing the documentation content
Returns
- Section
a documentation Section
AddRisksAndTechnicalDebtSection(SoftwareSystem, params FileSystemInfo[])
Adds a "Risks and Technical Debt" section relating to a SoftwareSystem from a file.
public Section AddRisksAndTechnicalDebtSection(SoftwareSystem softwareSystem, params FileSystemInfo[] files)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
filesFileSystemInfo[]one or more FileSystemInfo objects that point to the documentation content
Returns
- Section
a documentation Section
AddRuntimeViewSection(SoftwareSystem, Format, string)
Adds a "Runtime View" section relating to a SoftwareSystem.
public Section AddRuntimeViewSection(SoftwareSystem softwareSystem, Format format, string content)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
formatFormatthe format of the documentation content
contentstringa string containing the documentation content
Returns
- Section
a documentation Section
AddRuntimeViewSection(SoftwareSystem, params FileSystemInfo[])
Adds a "Runtime View" section relating to a SoftwareSystem from a file.
public Section AddRuntimeViewSection(SoftwareSystem softwareSystem, params FileSystemInfo[] files)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
filesFileSystemInfo[]one or more FileSystemInfo objects that point to the documentation content
Returns
- Section
a documentation Section
AddSolutionStrategySection(SoftwareSystem, Format, string)
Adds a "Solution Strategy" section relating to a SoftwareSystem.
public Section AddSolutionStrategySection(SoftwareSystem softwareSystem, Format format, string content)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
formatFormatthe format of the documentation content
contentstringa string containing the documentation content
Returns
- Section
a documentation Section
AddSolutionStrategySection(SoftwareSystem, params FileSystemInfo[])
Adds a "Solution Strategy" section relating to a SoftwareSystem from a file.
public Section AddSolutionStrategySection(SoftwareSystem softwareSystem, params FileSystemInfo[] files)Parameters
softwareSystemSoftwareSystemthe SoftwareSystem the documentation relates to
filesFileSystemInfo[]one or more FileSystemInfo objects that point to the documentation content
Returns
- Section
a documentation Section