Learning projectdoc

Section

Column

Document Properties Marker

override	false

Short Description

Getting started with the projectdoc Toolbox is not easy. Some basic concepts are more than just good-to-know and the number of macros and doctypes may be simply overwhelming. This tip gives some advice on how to get started.

Doctype

topic

hide

Name

Learning projectdoc

Short Name

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role
render-no-hits-as-blank	true
render-list-as-comma-separated-values	true
names	Documentation Architect, Documentation Gardener, Author, Template Author, Sponsor
property	Audience

Subject

Name List

doctype	subject
property	Subject

Sponsors

Name List

doctype	stakeholder
render-no-hits-as-blank	true
property	Sponsors

Sort Key

hide

enable-heading-numbers

true

hide

Column

width	350px

Panel

Table of Contents

outline	true
indent	10 px
style	none

Section

show-title	false
title	Description

The PDAC1 is a collection of macros to make documentation work more easy. This is basically done by reuse of parts of other pages by the use of transclusion and by enhancing navigation by the use of dynamic lists of links.

Getting to learn projectdoc, a look at use and show cases may be helpful as a first step. But different people usually have different approaches to learn. Some may approach by learning concepts first and try them out later. Some prefer to play with the tools and learn concepts and details later. This tip shows some approaches you may choose - not necessarily in the order provided.

Section

title	Summary

Section

title	Prerequisites

Section

Column

width	50%

Section

title	Use Cases

Due to the generic nature of the macros, they can be applied in many areas of documentation work. For instance the following use cases are supported:

Expand

title	Show use cases ...

Display Table

doctype	business-use-case
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
sort-by	Sort Key, Name
space-key	PDAC
header-translations	Categories=Category

Use cases provide links to more resources on their topic.

Column

width	50%

Section

title	Show Cases

How the macros can be applied to spaces is provided as examples in our show cases:

Expand

title	Show show cases ...

Display Table

doctype	topic
render-no-hits-as-blank	true
render-mode	definition
select	Documentation for, Documentation for->Short Description
sort-by	Sort Key, Name
where	$<DirectAncestorTitle>=[Show Cases]
space-key	PDAC

Section

title	Getting your Hands dirty ...

Learning projectdoc is best done by using it. To do so the projectdoc Toolbox provides a demo space to be created on your Confluence server.

This space explains a couple of projectdoc's concepts and - since the pages are editable in your space, makes it easy to see how it works and maybe play with its macros and pages.

There is also a Hands-on Tutorial to guide you through the process of creating some spaces and using tools from the toolbox by a step-by-step tutorial.

Section

Column

width	50%

Section

title	Starting with Concepts

As a new user follow this trail to learn the concepts of projectdoc:

A second option is to follow Think big, start small , where you learn the bare minimum and may switcgh to the Hands-on Tutorial quickly.

Column

width	50%

Section

title	Approach by Doctype Add-ons

Doctype add-ons provide blueprints for a number of use cases. Installing one (on top of the projectdoc Toolbox and maybe some of our free extensions) may help you get started with topics like documenting software projects, the work of agile teams, or service documentation.

Expand

title	Show doctype add-ons ...

Transclusion

document	PDAC:Doctype Add-on
ids	list-of-add-ons

Section

Column

width	50%

Section

title	Learning by Tips

Tips show various aspects of the projectdoc Toolbox. It includes arbitrary, but important ways on how to use its tools.

The list contains a number of tips that originate from questions asked by customers.

Column

width	50%

Section

title	One-on-Ones

If you would like to discuss your requirements with one of our team members, please schedule a 1:1!

In this session, typically an online chat or call about one hour long, we will discuss your topics and show how the projectdoc Toolbox can be used to organize your spaces.

Section

title	Subordinate Topics

Display Table

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

Section

required-permissions	write-access
title	Notes

Section

title	References

Section

title	Resources

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-tip
Type	howto

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 7

Key

About

Keep up-to-date!

Powered by