projectdoc Toolbox

Guided tours through existing information. This allows to aggregate topics for a given question or audience, thus providing a view on a topic.

Description

Tours allow to aggregate other documents suitable to answer a specific question. Usually topics cover a specific subject and tours allow to arrange these modules of information. While topics may also group this information in form of subtopics, tours are designed to stand out from topics.

Properties

The document type tour 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

Describes what question of the designated audience the tour will cover and may provide an overview over the single steps.

This is an descriptive abstract, similar to a table of contents.

For more information please refer to Description.

Summary

Summarize the key findings or essential information of the document. This is the informative abstract, while a Description contains the descriptive abstract.

The summary helps readers to get informed about the key points in a short section. It is also a tool to help readers of the document to recall the contents without scanning the whole document.

Subordinate Tours

In case the tour covers a really large area, it may be subdivided into smaller tours.

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.

Related Doctypes

Topics

Topics provide information about a certain subject. They are the basic modules of the documentation and are used where no more specific document type fits.

Generic

A generic document is like a topic, but has no default storage space. It is usually a related to another document. Use this doctype if you do not want the document instance show up in an index.

Typically you should either select Topic or Section instead of a generic document.