Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleTips 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

text
Code Block
language
Code Block Placeholder
> Operating System > Linux > Red Hat Linux > Red Hat Linux 7.2

Nodes 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.

...