...
Section | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Once you build your documentation with projectdoc documents, you can rely on the following features.
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!
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 | ||
---|---|---|
| ||
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:
We think the reward is larger than the investment. Do you agree? |
...