You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

projectdoc Toolbox

Links allow readers to find related information. Autocomplete allows authors to recall the names of related information. Let's have a closer look on the Autocomplete Feature of the projectdoc Toolbox!

Tags
Iteration
Filled
Type
Level of Experience
Our brains are not that good with recalling information. Even paper is better1. That is why we write documentation even if the documented tool is only used by us or a small team2: we communicate with our future self, relieve our overworked brains from the necessity to recall information. The projectdoc Toolbox for Confluence now brings this principle of "brain relieving" to authors, especially when they try to recall the name or title of a document. This new feature is called Autocomplete and this tip provides some insights for authors, but also for information architects or template authors, on how to use this brand new supplement of the projectdoc Toolbox.

References

Erfolgsmuster: Strukturierte Faulheit
Article in a German magazine by Peter Hruschka und Gernot Starke "Erinnern kann Papier erheblich besser als Hirn" (translated as "Paper recalls much better than the brain").
Both authors share their insights in documenting software systems and software architectures by publishing their arc42 Template. There are plenty of resources on the internet. In case you are using the projectdoc Toolbox you may have a look at the arc42 Doctype Add-on which provides the arc42 Template for Confluence.
I admit I have heard the rumor that some people actually do not like to write or read documentation.

  • No labels