projectdoc Toolbox

A single act to show on the review. Use this only if you have a lot to show or you want to reference the review results later. Often a simple numerated list is sufficient.

ID
review-act
Suite
Parent
Documentation Type
Categories
Tags

Description

Use Review Act documents, if your team decides to prepare the review collaboratively and in distinct groups.

Although you create a new document, this does not need that you have to put a lot of information into it. Usually keep your script small and use a list of things to show (or not to forget) and maybe paste some screenshots here and there to keep you visually on track for your review presentation.

Properties

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

Sections

Description

Describe what to show in this act. May be a numbered list or some subsections. This list is created as a preparation. It should only be a short script for the team to not forget something. Keep it short and simple.

Assessment

Note how the stakeholders assess what has been shown. Is there any new input to be remembered later? Is the shown result accepted by the stakeholders?

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.