projectdoc Toolbox

Documents a feature of the product. The top features define the main aspects of the product.

Document important features of your product. This helps to make the product vision colourful and comprehensible.

You may assign artifacts of your project to these features.

Properties

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

Importance

Defines the importance of the feature for the project.

In summaries, often only the most important features are listed. This property allows to select on features according to their importance.

 

You may also remove the macro value and replace it with a Name List Macro and its own type.

Sections

Teaser

Add information with reference to further resources and optionally a small image. Keep it short.

Note that this section is hidden per default to be transcluded.

Subordinate Features

Lists all subordinate features attached as child documents.

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

Feature Type
Feature types categorize features.
Out Item
Out Items record topics that are out of the scope of the project. This is useful for project inception and for reference in the future.
Out Item Type
Out item types categorize out items.
Project Constraint
Project Constraints limit the options of a project.
Project Constraint Type
Project constraint types categorize project constraints.
Project Vision
Frame the vision for a project or iteration.
Project Vision Type
Types to categorize vision statements for projects.
Quality Target
Documents a quality target for a product.
Requirement
Documents requirements of a product.
User Character
User Characters are the actors of user stories. They include personas and extreme characters.
User Character Type
User character types categorize user characters.