Versions Compared

Key

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

...

Document Properties Marker
overridefalse


Short DescriptionSystems are part of environments where products are deployed to. 
Doctypedoctypehide
NameIT System 
IDit-system 
SetService Management  
Parent
Parent Property
parent-doctypetopic
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 
Documentation Type

Name List
doctypedoctype-type
render-no-hits-as-blanktrue
namesQ4 - System
propertyDocumentation Type

 
Categories

Name List
doctypecategory
render-no-hits-as-blanktrue
names/ Services / Operations
propertyCategories

 
Tags

Tag List

 
Iteration

Iteration
value

facade

production

 hide
Sort Keyhide



Section
indextrue
show-titlefalse
titleDescription

Systems are part of environments where products are deployed to.

Systems are configuration items.

 


hide
Section
truetitleProperties


Transclusion
documentNote Box referencing common Document Properties
idsBox


Section
titleSuperordinate System

Systems may be composed. This is a reference to the superordinate system.

The value is typically automatically provided by the parent document.


Section
titleType

Specify the type of the system to organize them.

Use the IT System Type to define types of systems.


Section
titleLifecycle Phase

Specify the lifecycle phase this system is currently in.


Section
titleDocumentation

List documentation assets provided for this system.


Section
titleSoftware

List software assets this system depends on.


Section
titleAssets

List assets this system depends on.


Section
titleApplications

List of applications belonging to the system.


Section
titleIT Services

Add links to services this system depends on. Services will be rendered within a document section.


Section
titleIT Systems

Add links to systems this system depends on. Systems will be rendered within a document section.


Section
titleConfiguration Items

List configuration items this system depends on to be operational.


Section
titleStatus

Select the status of the system.

Use Configuration Item Status to document statuses.


Section
titleVersion

Specify the version of the application.


Section
titleApplication ID

Provide the application identifying part of the URI. Is usually appended to the URI of the system this system is installed to.


Section
titleURI

Specify the uniform resource identifier (URI) to the system.

This information may be used by the Access Information doctype.


Section
titleLogical Location

Provide the logical location for the system.


Section
titleLocation

Specify where the system is located.


Section
titleVendor Organization

Reference the organization that sells the system.


Section
titleVendor Contact

Reference the contact person of the vendor organization to access more information on the system or related information.


Section
titleAdministration Organization

Reference the organization that runs the system.


Section
titleAdministrator

Reference the contact person of the administration in case of technical problems.


Section
titleRemote Repositories

List of remote information repositories related to the system.



Sections
Section
titleSections


Section
titleDescription

Describe the system.


Section
titleDependencies

This section provides subsections to list information on dependencies.

The tables are automatically populated with references provided as values to properties. So typically this section is not edited manually. New dependencies are added as a value to the respective property.


Section
titleInterfaces

List and describe the interfaces provided by this system.


Section
titleInstallation

Describe the installation procedure of the system. Use a subsection for each step. This way you can add screen shots or console output to make things very easy. Adding this information is hard on lists. If the installation process is long and complicated, add a checklist or topic as a child document and refer to it from here. In case the installation is automated, just help the user to launch the installation process.


Section
titleConfiguration

Describe the typical or recommended configuration of the system. Again, use subsections for the individual steps. If the configuration process is long and complicated, add a checklist or topic as a child document and refer to it from here.


Section
titleBest Practices

An automatic list of work instructions relevant for running or working with this system.


Section
titleDeployments

List of deployments conducted for this system.


Section
titleAccess Information

If there is a document of type Access Information, this information is automatically rendered in this section by transclusion.

hidetrue
title


Transclusion
documentDocument Sections
idsstandard-sections-bottom


...

Section
titleReferences


Section
titleResources


Piwik Set Multiple Custom Variables


NameValue
Departmentprojectdoc
Categoryprojectdoc-doctype
Typeservice-management