Package com.structurizr.documentation.template

Class Arc42DocumentationTemplate

  • public class Arc42DocumentationTemplate
extends DocumentationTemplate

    An implementation of the arc42 documentation template, consisting of the following sections:

    1. Introduction and Goals
    2. Constraints
    3. Context and Scope
    4. Solution Strategy
    5. Building Block View
    6. Runtime View
    7. Deployment View
    8. Crosscutting Concepts
    9. Architectural Decisions
    10. Quality Requirements
    11. Risks and Technical Debt
    12. Glossary

    • Constructor Summary

      Constructors 
      Constructor Description
      Arc42DocumentationTemplate​(com.structurizr.documentation.Documentable documentable)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.structurizr.documentation.Section addArchitecturalDecisionsSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds an "Architectural Decisions" section.
      com.structurizr.documentation.Section addArchitecturalDecisionsSection​(java.io.File... files)
      Adds an "Architectural Decisions" section from one or more files.
      com.structurizr.documentation.Section addBuildingBlockViewSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Building Block View" section.
      com.structurizr.documentation.Section addBuildingBlockViewSection​(java.io.File... files)
      Adds a "Building Block View" section from one or more files.
      com.structurizr.documentation.Section addConstraintsSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Constraints" section.
      com.structurizr.documentation.Section addConstraintsSection​(java.io.File... files)
      Adds a "Constraints" section from one or more files.
      com.structurizr.documentation.Section addContextAndScopeSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Context and Scope" section.
      com.structurizr.documentation.Section addContextAndScopeSection​(java.io.File... files)
      Adds a "Context and Scope" section from one or more files.
      com.structurizr.documentation.Section addCrosscuttingConceptsSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Crosscutting Concepts" section.
      com.structurizr.documentation.Section addCrosscuttingConceptsSection​(java.io.File... files)
      Adds a "Crosscutting Concepts" section from one or more files.
      com.structurizr.documentation.Section addDeploymentViewSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Deployment View" section.
      com.structurizr.documentation.Section addDeploymentViewSection​(java.io.File... files)
      Adds a "Deployment View" section from one or more files.
      com.structurizr.documentation.Section addGlossarySection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Glossary" section.
      com.structurizr.documentation.Section addGlossarySection​(java.io.File... files)
      Adds a "Glossary" section from one or more files.
      com.structurizr.documentation.Section addIntroductionAndGoalsSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds an "Introduction and Goals" section.
      com.structurizr.documentation.Section addIntroductionAndGoalsSection​(java.io.File... files)
      Adds an "Introduction and Goals" section from one or more files.
      com.structurizr.documentation.Section addQualityRequirementsSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Quality Requirements" section.
      com.structurizr.documentation.Section addQualityRequirementsSection​(java.io.File... files)
      Adds a "Quality Requirements" section from one or more files.
      com.structurizr.documentation.Section addRisksAndTechnicalDebtSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Risks and Technical Debt" section.
      com.structurizr.documentation.Section addRisksAndTechnicalDebtSection​(java.io.File... files)
      Adds a "Risks and Technical Debt" section from one or more files.
      com.structurizr.documentation.Section addRuntimeViewSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Runtime View" section.
      com.structurizr.documentation.Section addRuntimeViewSection​(java.io.File... files)
      Adds a "Runtime View" section from one or more files.
      com.structurizr.documentation.Section addSolutionStrategySection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Solution Strategy" section.
      com.structurizr.documentation.Section addSolutionStrategySection​(java.io.File... files)
      Adds a "Solution Strategy" section 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

      • Arc42DocumentationTemplate

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

    • Method Detail

      • addIntroductionAndGoalsSection

        public com.structurizr.documentation.Section addIntroductionAndGoalsSection​(java.io.File... files)
                                                                     throws java.io.IOException
        Adds an "Introduction and Goals" section 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

      • addIntroductionAndGoalsSection

        public com.structurizr.documentation.Section addIntroductionAndGoalsSection​(com.structurizr.documentation.Format format,
                                                                            java.lang.String content)
        Adds an "Introduction and Goals" section.
        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 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.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addContextAndScopeSection

        public com.structurizr.documentation.Section addContextAndScopeSection​(java.io.File... files)
                                                                throws java.io.IOException
        Adds a "Context and Scope" section 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

      • addContextAndScopeSection

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

      • addSolutionStrategySection

        public com.structurizr.documentation.Section addSolutionStrategySection​(java.io.File... files)
                                                                 throws java.io.IOException
        Adds a "Solution Strategy" section 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

      • addSolutionStrategySection

        public com.structurizr.documentation.Section addSolutionStrategySection​(com.structurizr.documentation.Format format,
                                                                        java.lang.String content)
        Adds a "Solution Strategy" section.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addBuildingBlockViewSection

        public com.structurizr.documentation.Section addBuildingBlockViewSection​(java.io.File... files)
                                                                  throws java.io.IOException
        Adds a "Building Block View" section 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

      • addBuildingBlockViewSection

        public com.structurizr.documentation.Section addBuildingBlockViewSection​(com.structurizr.documentation.Format format,
                                                                         java.lang.String content)
        Adds a "Building Block View" section.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addRuntimeViewSection

        public com.structurizr.documentation.Section addRuntimeViewSection​(java.io.File... files)
                                                            throws java.io.IOException
        Adds a "Runtime View" section 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

      • addRuntimeViewSection

        public com.structurizr.documentation.Section addRuntimeViewSection​(com.structurizr.documentation.Format format,
                                                                   java.lang.String content)
        Adds a "Runtime View" section.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addDeploymentViewSection

        public com.structurizr.documentation.Section addDeploymentViewSection​(java.io.File... files)
                                                               throws java.io.IOException
        Adds a "Deployment View" section 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

      • addDeploymentViewSection

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

      • addCrosscuttingConceptsSection

        public com.structurizr.documentation.Section addCrosscuttingConceptsSection​(java.io.File... files)
                                                                     throws java.io.IOException
        Adds a "Crosscutting Concepts" section 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

      • addCrosscuttingConceptsSection

        public com.structurizr.documentation.Section addCrosscuttingConceptsSection​(com.structurizr.documentation.Format format,
                                                                            java.lang.String content)
        Adds a "Crosscutting Concepts" section.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addArchitecturalDecisionsSection

        public com.structurizr.documentation.Section addArchitecturalDecisionsSection​(java.io.File... files)
                                                                       throws java.io.IOException
        Adds an "Architectural Decisions" section 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

      • addArchitecturalDecisionsSection

        public com.structurizr.documentation.Section addArchitecturalDecisionsSection​(com.structurizr.documentation.Format format,
                                                                              java.lang.String content)
        Adds an "Architectural Decisions" section.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addQualityRequirementsSection

        public com.structurizr.documentation.Section addQualityRequirementsSection​(java.io.File... files)
                                                                    throws java.io.IOException
        Adds a "Quality Requirements" section 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

      • addQualityRequirementsSection

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

      • addRisksAndTechnicalDebtSection

        public com.structurizr.documentation.Section addRisksAndTechnicalDebtSection​(java.io.File... files)
                                                                      throws java.io.IOException
        Adds a "Risks and Technical Debt" section 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

      • addRisksAndTechnicalDebtSection

        public com.structurizr.documentation.Section addRisksAndTechnicalDebtSection​(com.structurizr.documentation.Format format,
                                                                             java.lang.String content)
        Adds a "Risks and Technical Debt" section.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • addGlossarySection

        public com.structurizr.documentation.Section addGlossarySection​(java.io.File... files)
                                                         throws java.io.IOException
        Adds a "Glossary" section 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

      • addGlossarySection

        public com.structurizr.documentation.Section addGlossarySection​(com.structurizr.documentation.Format format,
                                                                java.lang.String content)
        Adds a "Glossary" section.
        Parameters:
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section