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
titlePayoff - the Features

Once you build your documentation with projectdoc documents, you can rely on the following features.

Transclusion
taget-heading-level2
documentPDAC1:projectdoc Document
idsSelect Documents

The impact of this feature on your work is better navigation, since links that refer to related information are collected and displayed easily. New pages that match the constraints will be added automatically without having to edit the referring page. This increases maintainability!

Transclusion
taget-heading-level2
documentPDAC1:projectdoc Document
idsTransclude Sections and Properties

The feature impacts on easier collaboration. Smaller documents are more easily written and maintained independently. This supports teams to create documentation collaboratively. In addition to that information fragments may be transcluded at multiple locations, which again supports maintainability since changes are applied at one location.

Section
titleConclusion

The investment in time to define properties and sections is rather small. Furthermore most of the time effort is spent once by the template author on design time.

The investment in time to learn projectdoc, especially to learn about macros involved to render automatic lists and use transclusion, is probably much larger. Fortunately this is also a one-time investment.

What you gain:

  1. Automatic lists of matching documents - making navigation and maintenance much easier
  2. Support for modular documentation based on transclusion - making collaboration and reuse much easier

We think the reward is larger than the investment. Do you agree?

...