Information on managing systems.
Description
The doctypes listed here are related to documenting environments, nodes, and deployed artifacts in an UML style.
These doctypes may miss some properties that are relevant for actual system management tasks. We are working on doctypes that are dealing with system management use cases, but these templates are still under development.
If you want to add specific properties, you may add them to the doctypes listed here or clone them.
Please keep in mind that ancestor queries (i.e. searching in the hierarchy of a given document property) is only supported for blueprints (i.e. not in templates edited via the Confluence UI). So you need to clone the project projectdoc Doctypes for Software Development on Bitbucket to support these kind of queries.
Documents
Documents associated with this or one of the subcategories.
| Name | Short Description |
|---|---|
Document requirements you impose on artifacts. Artifacts are created by processes defined and used by the team. This includes assemblies created by the build process, source code artifacts or reports. |
|
Artifact types categorize artifacts. |
|
Data type types categorize data types. |
|
Document logical or physical groups of nodes. |
|
Type of an environment used by the project to deploy the application or the solution. |
|
Nodes are part of environments where artifacts are deployed to. |
Tips on using Doctypes
Each system element can be associated with type specific information. Types help to categorize and organize environments, nodes, and artifacts. Documentation Architects are free to design an information architecture that fits their needs since there are little or no constraints on the element and type doctypes.
One approach could be to have artifact types that document the form of the artifact. For instance JAR, ZIP, or XML file. These artifacts are then associated with nodes. You may define node types to model the operating systems you use. For instance one path in this hierarchy could be
> Operating System > Linux > Red Hat Linux > Red Hat Linux 7.2Nodes are then associated with "Red Hat Linux 7.2".
The physical nodes are then associated with physical environments. Logical information that applies to each physical environment is then documented with an environment type.