Package com.structurizr.documentation.template

Class ViewpointsAndPerspectivesDocumentationTemplate

  • public class ViewpointsAndPerspectivesDocumentationTemplate
extends DocumentationTemplate

    An implementation of the "Viewpoints and Perspectives" documentation template, from the "Software Systems Architecture" book by Nick Rozanski and Eoin Woods, consisting of the following sections:

    1. Introduction
    2. Glossary
    3. System Stakeholders and Requirements
    4. Architectural Forces
    5. Architectural Views
    6. System Qualities
    7. Appendices

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.structurizr.documentation.Section addAppendicesSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds an "Appendices" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addAppendicesSection​(java.io.File... files)
      Adds an "Appendices" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addArchitecturalForcesSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds an "Architectural Forces" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addArchitecturalForcesSection​(java.io.File... files)
      Adds an "Architectural Forces" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addArchitecturalViewsSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds an "Architectural Views" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addArchitecturalViewsSection​(java.io.File... files)
      Adds an "Architectural Views" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addGlossarySection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Glossary" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addGlossarySection​(java.io.File... files)
      Adds a "Glossary" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addIntroductionSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "Introduction" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addIntroductionSection​(java.io.File... files)
      Adds a "Introduction" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addSystemQualitiesSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "System Qualities" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addSystemQualitiesSection​(java.io.File... files)
      Adds a "System Qualities" section relating to a SoftwareSystem from one or more files.
      com.structurizr.documentation.Section addSystemStakeholdersAndRequirementsSection​(com.structurizr.documentation.Format format, java.lang.String content)
      Adds a "System Stakeholders and Requirements" section relating to a SoftwareSystem.
      com.structurizr.documentation.Section addSystemStakeholdersAndRequirementsSection​(java.io.File... files)
      Adds a "System Stakeholders and Requirements" 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

      • ViewpointsAndPerspectivesDocumentationTemplate

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

    • Method Detail

      • addIntroductionSection

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

      • addIntroductionSection

        public com.structurizr.documentation.Section addIntroductionSection​(com.structurizr.documentation.Format format,
                                                                    java.lang.String content)
        Adds a "Introduction" section relating to a SoftwareSystem.
        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 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

      • addGlossarySection

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

      • addSystemStakeholdersAndRequirementsSection

        public com.structurizr.documentation.Section addSystemStakeholdersAndRequirementsSection​(java.io.File... files)
                                                                                  throws java.io.IOException
        Adds a "System Stakeholders and Requirements" 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

      • addSystemStakeholdersAndRequirementsSection

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

      • addArchitecturalForcesSection

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

      • addArchitecturalForcesSection

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

      • addArchitecturalViewsSection

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

      • addArchitecturalViewsSection

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

      • addSystemQualitiesSection

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

      • addSystemQualitiesSection

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

      • addAppendicesSection

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

      • addAppendicesSection

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