Legend

From OIAr Archive 2013
Jump to: navigation, search

Naming conventions

Articles ("pages") in this knowledge system must have unique titles, and thus special measures must be taken in those cases where different things might have the same name.

For instance: there may be an environment "DMZ" under the Server Working Area, and an environment "DMZ" under the Network Working Area. This then concerns two different environments, each requiring their own article, which cannot both be named "DMZ". To facilitate this, a naming convention has been devised.

Overview of Building Block Model elements and their naming convention:

  • Working Areas:
    The article covering a Working Area is named after that Working Area, with a two-letter abbreviation of that name appended between parenthesis. Example: Server (SE).
  • Environment:
    The article covering an Environment is named after that Environment, prepended with ENV. to show the type of the artefact, and the two-letter abbreviation of the Working Area under which it resides. Example: ENV.CR.Office, for the Office ENVironment under the Client Realm (CR) Working Area.
  • Building Block Type:
    The article covering a Building Block Type is named after that Building Block Type, prepended with the prefix BT. to show the type of the artefact. Example: BT.Archiving.
  • Building Block Variant:
    The article covering a Building Block Variant is named after the Building Block Type on which it is based, prepended with the prefix BV. to show the type of the artefact, and appended with a descriptor of the variant, or the reason for the variation. Example: BV.Permission Validation.SAP for the SAP variant of the Permission Validation Building Block Type.
  • Element:
    Articles about Elements (software, protocols, naming standard et cetera) are named after the element, prepended with the prefix EL. to show the type of the artefact. Example: EL.Apache2, for the ELement "Apache 2".
  • Pattern Type:
    An article describing a Pattern Type is prepended with PAT. Example: PAT.Application Hosting for the Application Hosting pattern.
  • Pattern Variant:
    The article describing a Pattern Variant is prepended with PAV, contains the full name of the Pattern Type on which it is based, and is appended with a descriptor of the variant. Example: PAV.Application Hosting - Web.HT, a Pattern Variant for application hosting specifically for web access by humans (Web Human Traffic).