Class ViewpointsAndPerspectivesDocumentation
- Namespace
- C4.Net.Documentation
- Assembly
- C4.Net.Core.dll
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.
public class ViewpointsAndPerspectivesDocumentation : DocumentationTemplate- Inheritance
-
ViewpointsAndPerspectivesDocumentation
- Inherited Members
Constructors
ViewpointsAndPerspectivesDocumentation(Workspace)
Creates the viewpoints and perspectives template helper for a workspace.
public ViewpointsAndPerspectivesDocumentation(Workspace workspace)Parameters
workspaceWorkspaceThe workspace whose documentation will be populated.
Methods
AddAppendicesSection(SoftwareSystem, Format, string)
Adds a "Appendices" section relating to a SoftwareSystem.
public Section AddAppendicesSection(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
AddAppendicesSection(SoftwareSystem, params FileSystemInfo[])
Adds a "Appendices" section relating to a SoftwareSystem from a file.
public Section AddAppendicesSection(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
AddArchitecturalForcesSection(SoftwareSystem, Format, string)
Adds an "Architectural Forces" section relating to a SoftwareSystem.
public Section AddArchitecturalForcesSection(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
AddArchitecturalForcesSection(SoftwareSystem, params FileSystemInfo[])
Adds an "Architectural Forces" section relating to a SoftwareSystem from a file.
public Section AddArchitecturalForcesSection(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
AddArchitecturalViewsSection(SoftwareSystem, Format, string)
Adds an "Architectural Views" section relating to a SoftwareSystem.
public Section AddArchitecturalViewsSection(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
AddArchitecturalViewsSection(SoftwareSystem, params FileSystemInfo[])
Adds an "Architectural Views" section relating to a SoftwareSystem from a file.
public Section AddArchitecturalViewsSection(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
AddIntroductionSection(SoftwareSystem, Format, string)
Adds an "Introduction" section relating to a SoftwareSystem.
public Section AddIntroductionSection(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
AddIntroductionSection(SoftwareSystem, params FileSystemInfo[])
Adds an "Introduction" section relating to a SoftwareSystem from a file.
public Section AddIntroductionSection(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
AddSystemQualitiesSection(SoftwareSystem, Format, string)
Adds a "System Qualities" section relating to a SoftwareSystem.
public Section AddSystemQualitiesSection(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
AddSystemQualitiesSection(SoftwareSystem, params FileSystemInfo[])
Adds a "System Qualities" section relating to a SoftwareSystem from a file.
public Section AddSystemQualitiesSection(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
AddSystemStakeholdersAndRequirementsSection(SoftwareSystem, Format, string)
Adds a "System Stakeholders and Requirements" section relating to a SoftwareSystem.
public Section AddSystemStakeholdersAndRequirementsSection(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
AddSystemStakeholdersAndRequirementsSection(SoftwareSystem, params FileSystemInfo[])
Adds a "System Stakeholders and Requirements" section relating to a SoftwareSystem from a file.
public Section AddSystemStakeholdersAndRequirementsSection(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