Package com.structurizr.documentation.template

Class StructurizrDocumentationTemplate

  • public class StructurizrDocumentationTemplate
extends DocumentationTemplate

    A simple documentation template, based upon the "software guidebook" concept in Simon Brown's Software Architecture for Developers book, with the following sections:

    • Context
    • Functional Overview
    • Quality Attributes
    • Constraints
    • Principles
    • Software Architecture
    • Containers
    • Components
    • Code
    • Data
    • Infrastructure Architecture
    • Deployment
    • Development Environment
    • Operation and Support
    • Decision Log

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.structurizr.documentation.Section addCodeSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Code" section relating to a Component.
      com.structurizr.documentation.Section addCodeSection​(java.io.File... files)
      Adds a "Code" section relating to a Component from one or more files.
      com.structurizr.documentation.Section addComponentsSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Components" section relating to a Container.
      com.structurizr.documentation.Section addComponentsSection​(java.io.File... files)
      Adds a "Components" section relating to a Container from one or more files.
      com.structurizr.documentation.Section addConstraintsSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Constraints" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addConstraintsSection​(java.io.File... files)
      Adds a "Constraints" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addContainersSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Containers" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addContainersSection​(java.io.File... files)
      Adds a "Containers" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addContextSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Context" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addContextSection​(java.io.File... files)
      Adds a "Context" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addDataSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Data" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addDataSection​(java.io.File... files)
      Adds a "Data" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addDecisionLogSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Decision Log" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addDecisionLogSection​(java.io.File... files)
      Adds a "Decision Log" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addDeploymentSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Deployment" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addDeploymentSection​(java.io.File... files)
      Adds a "Deployment" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addDevelopmentEnvironmentSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Development Environment" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addDevelopmentEnvironmentSection​(java.io.File... files)
      Adds a "Development Environment" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addFunctionalOverviewSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Functional Overview" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addFunctionalOverviewSection​(java.io.File... files)
      Adds a "Functional Overview" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addInfrastructureArchitectureSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds an "Infrastructure Architecture" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addInfrastructureArchitectureSection​(java.io.File... files)
      Adds an "Infrastructure Architecture" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addOperationAndSupportSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Operation and Support" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addOperationAndSupportSection​(java.io.File... files)
      Adds an "Operation and Support" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addPrinciplesSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Principles" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addPrinciplesSection​(java.io.File... files)
      Adds a "Principles" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addQualityAttributesSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Quality Attributes" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addQualityAttributesSection​(java.io.File... files)
      Adds a "Quality Attributes" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addSoftwareArchitectureSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Software Architecture" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addSoftwareArchitectureSection​(java.io.File... files)
      Adds a "Software Architecture" section relating to a SoftwareSystem from one or more files.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • StructurizrDocumentationTemplate

        public StructurizrDocumentationTemplate​(com.structurizr.documentation.Documentable documentable)

    • Method Detail

      • addContextSection

        public com.structurizr.documentation.Section addContextSection​(java.io.File... files)
                                                        throws java.io.IOException
        Adds a "Context" section relating to a SoftwareSystem from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addContextSection

        public com.structurizr.documentation.Section addContextSection​(com.structurizr.documentation.Format format,
                                                               java.lang.String content)
        Adds a "Context" section relating to a SoftwareSystem.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addFunctionalOverviewSection

        public com.structurizr.documentation.Section addFunctionalOverviewSection​(java.io.File... files)
                                                                   throws java.io.IOException
        Adds a "Functional Overview" section relating to a SoftwareSystem from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addFunctionalOverviewSection

        public com.structurizr.documentation.Section addFunctionalOverviewSection​(com.structurizr.documentation.Format format,
                                                                          java.lang.String content)
        Adds a "Functional Overview" section relating to a SoftwareSystem.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addQualityAttributesSection

        public com.structurizr.documentation.Section addQualityAttributesSection​(java.io.File... files)
                                                                  throws java.io.IOException
        Adds a "Quality Attributes" section relating to a SoftwareSystem from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addQualityAttributesSection

        public com.structurizr.documentation.Section addQualityAttributesSection​(com.structurizr.documentation.Format format,
                                                                         java.lang.String content)
        Adds a "Quality Attributes" section relating to a SoftwareSystem.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addConstraintsSection

        public com.structurizr.documentation.Section addConstraintsSection​(java.io.File... files)
                                                            throws java.io.IOException
        Adds a "Constraints" section relating to a SoftwareSystem from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addConstraintsSection

        public com.structurizr.documentation.Section addConstraintsSection​(com.structurizr.documentation.Format format,
                                                                   java.lang.String content)
        Adds a "Constraints" section relating to a SoftwareSystem.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addPrinciplesSection

        public com.structurizr.documentation.Section addPrinciplesSection​(java.io.File... files)
                                                           throws java.io.IOException
        Adds a "Principles" section relating to a SoftwareSystem from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addPrinciplesSection

        public com.structurizr.documentation.Section addPrinciplesSection​(com.structurizr.documentation.Format format,
                                                                  java.lang.String content)
        Adds a "Principles" section relating to a SoftwareSystem.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addSoftwareArchitectureSection

        public com.structurizr.documentation.Section addSoftwareArchitectureSection​(java.io.File... files)
                                                                     throws java.io.IOException
        Adds a "Software Architecture" section relating to a SoftwareSystem from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addSoftwareArchitectureSection

        public com.structurizr.documentation.Section addSoftwareArchitectureSection​(com.structurizr.documentation.Format format,
                                                                            java.lang.String content)
        Adds a "Software Architecture" section relating to a SoftwareSystem.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addContainersSection

        public com.structurizr.documentation.Section addContainersSection​(java.io.File... files)
                                                           throws java.io.IOException
        Adds a "Containers" section relating to a SoftwareSystem from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addContainersSection

        public com.structurizr.documentation.Section addContainersSection​(com.structurizr.documentation.Format format,
                                                                  java.lang.String content)
        Adds a "Containers" section relating to a SoftwareSystem.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addComponentsSection

        public com.structurizr.documentation.Section addComponentsSection​(java.io.File... files)
                                                           throws java.io.IOException
        Adds a "Components" section relating to a Container from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addComponentsSection

        public com.structurizr.documentation.Section addComponentsSection​(com.structurizr.documentation.Format format,
                                                                  java.lang.String content)
        Adds a "Components" section relating to a Container.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addCodeSection

        public com.structurizr.documentation.Section addCodeSection​(java.io.File... files)
                                                     throws java.io.IOException
        Adds a "Code" section relating to a Component from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addCodeSection

        public com.structurizr.documentation.Section addCodeSection​(com.structurizr.documentation.Format format,
                                                            java.lang.String content)
        Adds a "Code" section relating to a Component.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addDataSection

        public com.structurizr.documentation.Section addDataSection​(java.io.File... files)
                                                     throws java.io.IOException
        Adds a "Data" section relating to a SoftwareSystem from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addDataSection

        public com.structurizr.documentation.Section addDataSection​(com.structurizr.documentation.Format format,
                                                            java.lang.String content)
        Adds a "Data" section relating to a SoftwareSystem.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addInfrastructureArchitectureSection

        public com.structurizr.documentation.Section addInfrastructureArchitectureSection​(java.io.File... files)
                                                                           throws java.io.IOException
        Adds an "Infrastructure Architecture" section relating to a SoftwareSystem from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addInfrastructureArchitectureSection

        public com.structurizr.documentation.Section addInfrastructureArchitectureSection​(com.structurizr.documentation.Format format,
                                                                                  java.lang.String content)
        Adds an "Infrastructure Architecture" section relating to a SoftwareSystem.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addDeploymentSection

        public com.structurizr.documentation.Section addDeploymentSection​(java.io.File... files)
                                                           throws java.io.IOException
        Adds a "Deployment" section relating to a SoftwareSystem from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addDeploymentSection

        public com.structurizr.documentation.Section addDeploymentSection​(com.structurizr.documentation.Format format,
                                                                  java.lang.String content)
        Adds a "Deployment" section relating to a SoftwareSystem.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addDevelopmentEnvironmentSection

        public com.structurizr.documentation.Section addDevelopmentEnvironmentSection​(java.io.File... files)
                                                                       throws java.io.IOException
        Adds a "Development Environment" section relating to a SoftwareSystem from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addDevelopmentEnvironmentSection

        public com.structurizr.documentation.Section addDevelopmentEnvironmentSection​(com.structurizr.documentation.Format format,
                                                                              java.lang.String content)
        Adds a "Development Environment" section relating to a SoftwareSystem.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addOperationAndSupportSection

        public com.structurizr.documentation.Section addOperationAndSupportSection​(java.io.File... files)
                                                                    throws java.io.IOException
        Adds an "Operation and Support" section relating to a SoftwareSystem from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addOperationAndSupportSection

        public com.structurizr.documentation.Section addOperationAndSupportSection​(com.structurizr.documentation.Format format,
                                                                           java.lang.String content)
        Adds a "Operation and Support" section relating to a SoftwareSystem.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addDecisionLogSection

        public com.structurizr.documentation.Section addDecisionLogSection​(java.io.File... files)
                                                            throws java.io.IOException
        Adds a "Decision Log" section relating to a SoftwareSystem from one or more files.
        Parameters:
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addDecisionLogSection

        public com.structurizr.documentation.Section addDecisionLogSection​(com.structurizr.documentation.Format format,
                                                                   java.lang.String content)
        Adds a "Decision Log" section relating to a SoftwareSystem.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section