projectdoc Toolbox

Deployments provide information about updates on services and systems to users.

ID
deployment
Suite
Parent
Documentation Type
Categories

Properties

The document type deployment 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.

Type

Specify the type of the deployment to organize them.

Use the Deployment Type to define types of deployments.

IT Services

List the services that are affected by this deployment.

Take into account that not all services relying on a affected system may themselves be affected.

IT Systems

List the systems that are updated by this deployment.

Assets

List the assets that are deployed to the referenced systems and take affect on the referenced services.

Date

Log the date of the deployment that made the product available to its users.

Available until

Log the date the availability of the product ends.

This may be of relevance for presentation systems.

Contact

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

Sections

Description

Describe the context of the deployment for users of the related services and systems.

List of Services

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

List of Systems

Automatically generated list of all systems that are part of this  deployment.

List of Assets

Automatically generated list of all assets related to this  deployment that are relevant to the users of the services and systems.

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.