You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

projectdoc Toolbox

Deployments are requested and fulfilled. This instructs a member of the delivery team to provision an environment with a specific system.

ID
deployment
Set
Documentation Type

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.

Deployment Requestor

Reference the name of the stakeholder who is running the deployment.

Requested Date

Log the date at which the requested deployment should be made available.

Deployer

Reference the name of the stakeholder who requested the deployment.

IT System

Reference the system to which the deployment is requested.

Deploy 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.

Sections

Request Description

Provide information about what is to be deployed and any additional constraints and requirements.

Description

Describe what has been done to deploy the product and any official information about the deployment.

Deployment Steps

Describe the manual steps to deploy the product.

Rollback Steps

Describe what has been done in the case of a rollback.

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.



  • No labels