You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

projectdoc Toolbox

Document the purpose and usage of a space blueprint.

ID
space-blueprint
Set
Add-on
Categories
Iteration
Filled
Since
1.0

Properties

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

Type

Declare the type of this space blueprint. This information is used for categorization and allows to collect all blueprints on the referenced type page.

Content

Since

Specify since which version this feature is available.

Deprecated

Specify since which version this feature is marked as deprecated.

Removed

Specify since which version this feature has been removed.

Sections

Description

 Document the purpose and usage of this space blueprint.

Properties

Provide information about the purpose and usage of each of the space blueprint's properties. These properties are defined of the homepage of the space or on delegate documents for this space.

Pages

Provide information about the purpose and usage of each of the space blueprint's generated pages.

Details

Provide detailed information on using this space blueprint. This allows to give background information on concepts and best practices.

Related Space Blueprints

Describe the features of related space blueprint and describe the use cases to your users.

Subordinate Space Blueprints

Provide information for space blueprints that provide content that is used for the creation of spaces by this blueprint.

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.

  • No labels