projectdoc Toolbox

Document tools used by the team. Add information about how to fetch, install and best practices using it.

ID
tool
Suite
Parent
Documentation Type
Tags
Teamwork

Document tools used by the team. Add information about how to fetch, install and best practices using it.

Properties

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

Specify the type of the tool to organize them.

Use the Tool Type to define types of tools.

Homepage

Add a link to the tool's homepage.

License

Provide the name of the license under which the tool is used.

Download

Reference the location where the software can be downloaded. It might be the official download page of the tool's vendor or - for more conservative approaches - a link to a local copy.

Reference

Provide a reference to the location where the tool can be used locally.

If the tool is a server, this is the link to locally installed server.

Sections

Description

Provide a short description of the tool and its relevance for the project.

Installation

Describe how to install the tool. This can be as simple as a reference to an online manual or it can be a step-by-step guide that takes into account the team's environment.

Consider using the Steps Macro.

Configuration

Describe how to configure the tool to meet the requirements of the team.

Consider using the Steps Macro.

Best Practices

Describe some best practices according the usage of the tool. Add a subsection for each practices and show them here in a tabular form. Usually sorted by the name of the practice.

The practice may also be described in form or a pattern. For most cases a simple Section documentor a section within this section is more helpful.

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.