projectdoc Toolbox

Properties are part of the configuration options of a system.

Description

Document configuration options of your system. Each property is defined in its own document so that it is easy to references these options from your documentation individually.

Properties

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

Identifier

Define the unique identifier of the property.

Component

A reference to the component of the system this property is part of.

Mandatory

Define the property is mandatory or optional. 

Type

Define the datatype of the property. 

Short Type

Define the short name of the property's datatype. 

Default Value

Specify the default value for the property, if no value is defined explicitly. 

Value Range

Define the range of valid values for the property within the specified type. 

Implementation

Add the Identifier (e.g. URI) and reference to the implementation of the property (e.g. a reference to the Javadoc of a Java property).

Since

Specify the version of the component since when this property is valid.

Deprecated Since

Specify the version of the component since when this property is deprecated. 

Until

Specify the last version of the component that supported this property. 

Reference

Add references to information on external systems here. 

Sections

Description

Provide a detailed description of the component. Add any additional sections to this one (if required) to document details on the design or responsibilities of the component.

Example of Usage

Show how to use the property and the effect on the system.

Subordinate Properties

A complex property may contain several parts that may be documented 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.

 

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.