projectdoc Toolbox

Document a single change to configuration items or assets.

Categories
ID
change
Suite
Since
3.2

Description

A change references all configuration items or assets that are altered for a planned change. Changes are than associated with releases so that users understand the changes and their implications for assets, services and their components.

Properties

The document type change 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

Define the unique identifier of the change.

Type

Specify the type of the change to organize them.

Use the Change Type Dopctype to define types of changes.

Severity

Document the severity of the change and thereby the urgency with which this change needs to be addressed.

Theme

Group distantly related changes by a theme. Organize closely related changes by parent relationship.

Deadline

Log the date the change is required to be solved.

Status

Define the status of the change.

Release References

Provide references to releases that conduct this change.

IT Services

List services, typically identified by their version, that require this change.

IT Systems

List systems, typically identified by their version, that require this change.

Configuration Items

List configuration items, typically identified by their version, that require this change.

Assets

List assets, typically identified by their version, that require this change.

Participants

List stakeholders, organizations, and persons who take part on working on this change.

Reference

Provide a reference to further information on this change on a remote service.

Assignee

Provide a reference to a team member (stakeholder), who is responsible for conducting this change.

Contact

Provide a reference to a stakeholder, with whom stakeholders may get in touch for further information.

Sections

Description

Document the impact of the change here. This may be a short summary in a couple of paragraphs that can be shown in the release notes.

Workarounds

Describe temporary solutions to the problem until this change is implemented.

Releases

Automatically generated list of releases this change is part of.

Requirements

List requirements for this change.

 

The requirement doctype is part of the Software Development Doctypes.

In case this add-on is not in use, simply replace the contents of this section. The change doctype still works in case the requirement doctype is not installed. This section simply renders no hits.

Breaking Changes

Describe implications of the change that remove or break existing features. These implications require the user's attention.

List of Services

Automatically generated list of all services with an impact by this change.

List of Systems

Automatically generated list of all systems with an impact by this change.

List of Configuration Items

Automatically generated list of all configuration items with an impact by this change.

List of Assets

Automatically generated list of all assets related to this change.