- Created by Robert Reiner, last modified on 25. Jun 2020
projectdoc Toolbox
Configuration items (CIs) may be (sub-)systems or components. Whatever may change and needs to be tracked may be documented as a CI.
- ID
configuration-item- Suite
- Parent
- Documentation Type
- Categories
- Iteration
- Production
Properties
The document type configuration-item provides the following properties:
Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.
Identifier
The unique identifier of the configuration item defined by the owning organization.
Unlike the URI the unique identifier may not be published or may identify a specific configuration item that is accessible via a shared URI.
Superordinate Configuration Item
Configuration items may be nested. This is the reference to the superordinate configuration item.
This value is automatically generated from the parent if it has the same doctype.
Type
Specify the type of the configuration item to organize them.
Use the Configuration Item Type to define types of configuration items.
Lifecycle Phase
Specify the lifecycle phase this configuration item is currently in.
Since 3.3
Since version 3.3 the Name List Macro selects on lifecycle phases that belong to the lifecycle Configuration Item Lifecycle.
If this does not suite your use case, please update the Where parameter accordingly.
IT System
A link to the system this configuration item is part of.
This value is automatically generated if there is a an ancestor of the IT System doctype.
Status
Select the status of the configuration item.
Use Configuration Item Status to document statuses.
Version
Specify the version of the configuration item.
URI
Specify the uniform resource identifier (URI) to the configuration item. Relevant if the the configuration item can be addressed individually.
This information may be used by the Access Information doctype.
Logical Location
Provide the logical location for the configuration item.
Location
Provide the physical location for the configuration item.
Documentation
List documentation assets provided for this configuration item.
Software
List software assets this configuration item depends on.
Assets
List assets this configuration item depends on.
IT Services
Add links to services this configuration item depends on. Services will be rendered within a document section.
IT Systems
Add links to systems this configuration item depends on. Systems will be rendered within a document section.
Configuration Items
List configuration items this configuration item depends on to be operational.
Vendor Organization
Reference the organization that sells the configuration item.
Vendor Contact
Reference the contact person of the vendor organization to access more information on the configuration item or related information.
Administration Organization
Reference the organization that runs the configuration item.
Administrator
Reference the contact person of the administration in case of technical problems.
Remote Repositories
List of remote information repositories related to the configuration item.
Sections
Description
Describe the configuration item.
Dependencies
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.
Interfaces
List and describe the interfaces provided by this configuration item.
Installation
Describe the installation procedure of the configuration item. 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.
Configuration
Describe the typical or recommended configuration of the configuration item. 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.
Best Practices
An automatic list of work instructions relevant for running or working with this configuration item.
Deployments
List of deployments conducted for this configuration item. Typically configuration items are not deployed separately, but there is no hard rule that they cannot.
Access Information
If there is a document of type Access Information, this information is automatically rendered in this section by transclusion.
Notes
These are internal notes that are usually not exported and only visible to team members with write access.
But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.
The text of notes sections is also indexed.
References
For a document the references section contains pointers to resources that prove the statements of the document.
Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.
For further information please refer to References and Resources.
Resources
The resources section provides references to further information to the topic of the document.
This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.
For further information please refer to References and Resources.
