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
titleTools

In a project team members usually have not much time to organize and reorganize information. So we are looking for some time-savers that support teams on creating project documentation collaboratively. We will not dive into any specifica here, but investigate generic approaches that are helpful for any project or communication need.

We examine the following tools:

  1. Categories68550679
  2. Tags68550679
  3. Subjects68550679
  4. Specific Types68550679
  5. Doctypes in General
  6. Simple Values68550679
  7. Automatic Lists

Knowing these tools for categorizing your information will improve your documentation in aspects of extending and navigating.

...

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).


...