projectdoc Toolbox

Improvement proposals help to start the conversation within the team for process improvements.

ID
improvement
Suite
Parent
Documentation Type
Categories
Tags

Description

Propose an improvement of your team's way of collaboration. These proposals help to start the conversation within the team for process improvements.

Properties

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

Severity

Measure the impact this improvement will have on your work. The higher the severity, the most likely it should be to put this improvement into place.

Driver

Name the team members that want to have the improvement applied and help to implement it.

Deadline

Log the date the improvement should be implemented.

Status

The status makes it easy to select improvement proposals. It is a very lightweight tracking tool. If you prefer to use JIRA for tracking changes, leave this property blank and simply link your JIRA issue with the improvement document where you might choose to add additional information.

Reference

Add references to information on external systems here. Probably this is an issue on your JIRA server.

Sections

Description

Describe the impediment that has been identified and the improvement that should remove it.

Impact

Describe the impact the improvement will have on the project. This has to be written from the business' perspective.

Test

Describe how it can be tested that the improvement has been successfully implemented.

Resolution

Provide information about how the improvement has been applied.

Subtasks to the Improvement

If for reason of complexity or collaboration you want to split the information for this improvement into several child documents, add them here.

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.