Tool

...

Document Properties Marker

override	false

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

Doctype doctype hide

Name Tool

ID tool

Suite Teamwork

Set Teamwork hide

Parent

Parent Property

parent-doctype	topic
property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property	Audience

Documentation Type

Name List

doctype	doctype-type
render-no-hits-as-blank	true
names	Q2 - Project
property	Documentation Type

Tags

Tag List

names	Teamwork

Iteration


value	production

hide

Sort Key hide

Section

index	true
show-title	false
title	Description

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

...

Section

title	Properties

Transclusion

document	Note Box referencing common Document Properties
ids	Box

Section

title	Type

Specify the type of the tool to organize them.

Use the Tool Type to define types of tools.

Section

title	Homepage

Add a link to the tool's homepage.

Section

title	License

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

Section

title	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.

Section

title	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.

Section

title	Sections

Section

title	Description

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

Section

title	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.

Section

title	Configuration

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

Consider using the Steps Macro.

Section

title	Best 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

document	Document Sections
ids	standard-sections-bottom

Section

title	Details

Section

index	true
title	Related Doctypes

Section

index	true
title	Sub-Subordinate Doctypes

Display Table

doctype	doctype
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

...

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 6

New Version Current

Key

About

Keep up-to-date!

Powered by