Blog

  • 2024
  • 2023
  • 2022
  • 2021
  • 2020
  • 2019
  • 2018
  • 2017
  • 2016
  • 2015
  • 2014
  • 2013
  • 2012

Versions Compared

Key

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

...

Section
titleIntroduction

Confluence is a perfect tool for online team collaboration. It makes it easy for everyone on the team to add information. Due to a lack of structure the team wiki may pretty fast become a place where it gets more and more difficult to add information so that it can be found in a reasonable amount of time. It also gets harder for team members to know where to add new content.

Image Modified

In the last article, Finding without Searching, we examined the different ways of information seeking needs and behaviors. We came to the conclusion that categorizing information is the key to understanding and to support the users of an information system. In the context of a project the users are first and foremost the members of the teams and stakeholders with access to the project wiki.

Let's examine how to apply categories with tools provided by Confluence and projectdoc.

...

Section
titleAutomatic Lists

Once you have organized the documents in your space and labelled them, it is easy to render context-sensitive links with automatic lists.

You may define queries to list all documents with a set of properties bound to specific values. These automatic lists - automatic since new documents will be automatically matched and show up in the list - are a helpful tool to define context sensitive navigations.

The following projectdoc macros are rendering automatic lists:

Display Table
doctypeapp-macro, macro
render-modedefinition
where$<Tags> = "Automatic Dynamic List"
space-keyPDAC1

The basic principle behind the combination of categorization and automatic list is the open/closed principle: Your documentation is open for extension, but each individual document is closed for modification. If you add a new document you extend your documentation. But you do not need to modify existing documents. This helps you creating and maintaining your documentation as a team.

Tip Box

If you have long lists of query results you may choose to further create partitions. This may be by adding subtypes (an option not available for simple values) or you may define queries to dissect your result list in multiple list. A Space Index is typically used to hold a list of related information where you do not want to use an instance of a particular doctype (such as a topic or resource).


...