Reports document what the team has decided or done. This is a generic document.

ID
report
Suite
Project Management
Parent
Doctypes for Project Management
Documentation Type
Q2 - Project
Categories
Since
3.1

Description

Use the Report Doctype to provide information to other stakeholders.

Properties

The document type report provides the following properties:

Type

Group reports by their type.

A project may provide its own set of types via the Report Type.

Participants

List stakeholders, persons, and organizations that are actively or passively related to this report.

Sponsors

List stakeholders that are actively interested to invest resources to create and communicate this report.

Note that sponsors need not participate with the report.

Publication Date

Specify the date of the creation of this report.

Sections

Description

Describe the purpose of the reports without providing information about its contents. This should allow readers to estimate if the report provides valuable information for their questions.

Motivate the relevance of this report.

Summary

Provide a summary for executives that need to get a quick overview over the content of the report.

Context

Describe the context in which the results of the report have been created.

Results

List the results of the work this report is about.

Outlook

Provide information about possible next steps.

Subordinate Reports

A complex report may be divided into separate, smaller reports that address certain aspects individually.

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.

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.

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.