Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse

Short DescriptionLinks 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!
Doctypetopichide
NameSupport Recalling
Short Name
Parent
Parent Property
property-nameName
hide
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
property

-restrict-value-range

trueproperty
Audience

empty-as-none

true
Subject
Name List
doctypesubject
propertySubject

Categories

Name List
doctypecategory
property-restrict-value-rangetrue
propertyCategories


Tags

Tag List
namesAutocomplete
propertyTags


Flagshide
Iteration

Iteration
valuefilled


Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
property-restrict-value-rangetrue
propertyType


Level of Experience

Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesCompetent
propertyLevel of Experience


Expected Duration
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide
Section
show-titlefalse
titleDescription
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.
Section
titleSummary

Section
titlePrerequisites

...

Section
titleReferences
Tour
render-no-hits-as-blanktrue
render-as-definition-listtrue
marker-column-property-nameTitle
replace-title-with-nametrue
TitleShort Description

Anchor
footnote-1
footnote-1
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.

Anchor
footnote-2
footnote-2

We love to write documentation, don't we?

I admit I have heard the rumor that some people actually do not like to write or read documentation.



Section
titleResources
Tour
render-no-hits-as-blanktrue
render-as-definition-listtrue
marker-column-property-nameTitle
replace-title-with-nametrue
TitleShort Description


...