Child pages
  • Navigability

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionI need better navigation in my Confluence space(s)! How can projectdoc help me? 
Doctypefaqhide
NameNavigability 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 
Subject
Name List
doctypesubject
propertySubject
 
Categories
Name List
doctypecategory
propertyCategories
 
Tags
Tag List
namesPractical Advice
propertyTags
 
Iteration
Iteration
valuefinished
 hide
Sort Key000200003000200hide
Section
titleDescription

Section
titleQuestion

I need better navigation in my Confluence space(s)! How can projectdoc help me?

Section
titleAnswer

To enhance the navigability of your space, use labels, add automatic lists or tours.

Section
level2
titleLabels

Your space is easier to navigate, if users know where to click to find the information they are looking for. So it all starts with labels. With labels we mean any form of text which especially includes the link text. If users cannot decide by the link text whether or not a click will take them nearer to their destination, add additional text that describes the content the link points to. This is done by short descriptions you are forced to add to all projectdoc documents.

Example for a Wizard that requests a name and a short description

So to enhance navigability add meaningful names and short descriptions to your documents.

Section
level2
titleAutomatic Lists

Automatic list build upon labels. The help authors to define queries by page properties.

  • List all documents with the same parent as this one!
  • List all documents tagged with "free" and ("beaver" or "squirrel")!
  • List all views on component "X"!

Whenever there is a new document that matches one of these queries, a link will be added automatically to this list. This makes it easier for users to find information to a defined topic. It also makes the work of document authors easier, since the list are always up to date.

Tip Box

The team should revisit the lists from time to time to check that the listed documents are still relevant. There is the danger of links creeping in by false labelling. If you want to remove this threat to the consistency of your navigation, try tours.

The following macros automatically create lists of references:

Display Table
doctypemacro
render-modedefinition
whereTags = "Automatic List"
space-keyPDAC1

Section
level2
titleTours

A tour is a handcrafted list of references to documents. The reason why you prefer the Tour Macro over a simple HTML list is that you can include information from the referenced document very easily.

Transclusion
documentPDAC1:Tour Macro
idsExample

You may also use a number of display document property macros to reference document properties and render a link to the document.

The following macros help to reference documents by adding document information to the link:

Display Table
doctypemacro
render-modedefinition
whereTags = "Property Value Transclusion"
space-keyPDAC1

Section
titleFurther Practical Advices
Display Table
doctypefaq
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Descriptionrender-modedefinition
sort-bySort Key, Name
whereParent = "Practical Advice"
exclude-selftrue

...