projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 8

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version Current

changes.mady.by.user Robert Reiner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleProperties


Transclusion
documentNote Box referencing common Document Properties
idsBox


Section
titleType

Specify the type of the tool to organize them.

Use the Tool Type to define types of tools.


Section
titleHomepage

Add a link to the tool's homepage.


Section
titleLicense

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


Section
titleDownload

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.


Section
titleReference

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.



Section
titleSections


Section
titleDescription

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


Section
titleInstallation

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.


Section
titleConfiguration

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

Consider using the Steps Macro.


Section
titleBest Practices

Describe some best practices according the usage of the tool. Add a subtopic 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.


Transclusion
documentDocument Sections
idsstandard-sections-bottom


...

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH