Don't include your own footer since the PlantUML config file (described below) will then be ignored.it has the side-effect of generating a slightly different image each time (simulating human randomness) which confuses Git
HRD ARCH CODE
If you create a Design Artifact using PlantUML, store the source code for that artifact in a sub-folder based upon the kind of artifact it is, using this pattern. Such artifacts are used to generate images as part of the Map build plan. Use PlantUML wherever possible to create design artifacts (UML diagrams, flow diagrams, models). Not all components are expected to have Design Artifacts of all of these types. Use the following names for these sub-folders: Within the resource folder, you can create sub-folders that describe the type of design artifact it is. For example, when describing the Versions component it may be useful to include a UML sequence diagram that illustrates the message flow for auto-creation of versions.ĭesign Artifacts are stored in folder called resource. Design ArtifactsĪt any level in the Map, an author may find it useful to include graphics or other renditions of Design Artifacts that help explain details of that component.
HRD ARCH FREE
So feel free to choose a color scheme from the available colors in shields.io, e.g. the Google Docs Connector has a different versioning scheme than Alfresco Content Services). NOTE: Not all components follow the same versioning scheme (e.g. That may mean that sometimes there are multiple sections, each for a different version. If a portion of the article pertains to a particular version, use a badge for that particular section, to signify that that section only applies to a particular version. Use a Version Badge at the top of the article, directly below the Completeness Badge, to signify the version of the product to which the article primarly applies. = green for Alfresco One 5.1 | orange for Alfresco Content Services 5.2 | blue for Alfresco future = The latest version to which the article applies, e.g. It should be placed directly below the article title. This should be used to signify the level of completeness of the article. Badgesīadges should be used to signify the completeness of the article and the version to which a component article applies. You can always create sub pages if there is too much to cover in this timeframe. Keep the level of detail appropriate to this timeframe. Remember that someone should be able to read, digest and understand the component in around 2 - 3 hours. If a section of the template does not apply to this component, add the text 'Not Applicable'. If a section of the template has not yet been completed, leave that section empty. While the component is being designed, use a Badge that marks it as a 'Work in Progress'(see below). An example of such a section is the Class Diagram. While the design is being worked on, certain sections of the article will be left blank until the design and implementation have proceeded far enough to complete them. When starting the design of a new component, start with a template. When creating a Component Article, use this template so you cover all the important aspects of the architecture of that Component.Ī Component Article is also used as a design document template. system/subsystem/repository/meta-data-services/versions-1.0Ī Component Article describes one component of the Subsystem.