Versions Compared

Key

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

...

Section


Column


Document Properties Marker
overridefalse


Short DescriptionCategories provide easy navigation. The category page documenting the category automatically lists all documents tagged with this category. A defined set of categories has per default no such homepage.
Doctypetopichide
NameNavigating Documentations
Short Name
Parent
Parent Property
property-nameName
hide
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesDocumentation Architect, Documentation Gardener, Template Author, Author
propertyAudience


Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags

Tag List
propertyTags


Flagsprojectdoc Toolbox, Confluence, navigationhide
Iteration

Iteration
valuefocused

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

Level of Experience

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


Expected Duration
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide




Column
width300px


Panel
titleContents

Table of Contents
indent15px
excludeResources
stylenone




Section
show-titlefalse
titleDescription

Browsing documentations is supported by many tools. One of them are document types which support navigation by linking to documents of their type. An information model defines categories of different types that are used to label documents. Navigation is possible from a document to its categories and each category document lists all documents labeled with this category.

Example Box

The Topic doctype defines a property named Type that links to an instance of the Topic Type doctype. A topic type may be Howto. A topic document of type howto set its type property to the value of Howto. The Howto document lists all topic documents of its type.

A document provides no means to link to a document that lists all documents tagged with two different types. The Space Index doctype mainly serves navigation purposes. The document provides links to related information. Therefore this doctype can be used to add indices to a space to list documents matching a combination of categories. The overview is still two clicks away, but at least it exists!

Tip Box
titleInformation Architecture

Please refer to the blog posts Finding without Searching and Finding without Searching - applied! for an introduction to creating an information architecture!

This tip shows how to create such an index document.

...