Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionAn overview over the use cases for which the projectdoc Toolbox provides support.
 

Doctypetopichide
NameUse Cases
 

Parent
Parent Property
propertyParent
property-nameName
 

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience
 

Expected Duration
 

Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
propertyTags
 

Iteration

Iteration
value

filled

finished

hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
propertyType
 

Sort Keyhide
Section
show-titlefalse
titleDescription

Working with templates turns your mind to focus on the content you want to communicate.

As an author it is still your responsibility to align your information with the structure of your document to help your readers getting to the point quickly. The structures of the templates aside, there is a basic structure that support you getting your stuff right.

  1. First motivate why the information is relevant for your audience. Define what the information is good for.
  2. Define the context the information is relevant in. Discuss the topic in-depth and provide the necessary background information.
  3. Provide examples on how to use or how it is already used. Maybe help your audience with a step-by-step guide.
  4. Envision on what will be next and possible extension points.
References Box

This four-step approach is explained in more detail by Stefan Zörner and Uwe Vigenschow. Their work is based on the quadrants typology of Carl Gustav Jung.

The following links provide more information on this topic, albeit in German:

The templates are guides to help you find areas to cover. They may or may not come naturally in the specified sequence of section. If the order of sections in the template does not support your point, change it! Your structure must support the information you transport.

Sections that do not help your topic are just left empty. If you later find they might contribute, add content and they will appear to your readers.

...