projectdoc Toolbox

Document a platform for apps.

Categories
ID
app-platform
Suite
Since
1.0

Apps require a certain platform to run. Describe this platform! Do not assume that anybody already knows the platform your app is built for. This document allows you to give a brief introduction for the platform and provide pointers to further information.

Properties

The document type app-platform 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 platform. This information is used for categorization and allows to collect all platforms on the referenced type page.

Minimum Version

Specify the minimum version required for the platform for the app to run on.

Maximum Version

Specify the maximum version required for the platform for the app to run on.

Sections

Description

Provide a short introduction for the platform for apps.

Subordinate Platforms

Provide information of subordinate platforms.

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.