CARDS+

Aus eigener Erfahrung wird ein Gärtner regelmäßig mit der Frage konfrontiert, ob im Seitentitel das Präfix für den Baustein wirklich notwendig ist. Das Präfix ist in erster Linie eine Kennzeichnung, ein Stereotyp. Es zeigt an, welcher Baustein die Grundlage für diese Seite ist, welcher Aspekt in der Seite behandelt wird.

Ein Stereotyp (englisch: stereotype) ist eine Erweiterung vorhandener Modellelemente in der Unified Modeling Language (UML). In der Praxis geben Stereotype vor allem die möglichen Zusammenhänge bei der Verwendung (Verwendungskontext) einer Klasse, einer Beziehung oder eines Paketes an.

Ähnlich wie bei UML-Diagrammen haben wir in einer technischen Dokumentation Modellelemente: Im Wiki sind es Seiten. Seiten bieten für alle gleiche Grundfunktionen, bestehend aus neun Überschriftenebenen, drei Absatzformaten (normal, für Code, für ein Zitat) und kombinierbaren Schriftstilen (fett, kursiv, unterstrichen, durchgestrichen).

Continue reading

Der Hersteller von Confluence scheint offensichtlich anzunehmen, dass Löschen von Seiten mit vielen Unterseiten oder einer Seitenhierarchie mit mehreren Ebenen in der Praxis recht selten vorkommt. Nur so kann ich mir erklären, dass Confluence erst seit kurzer Zeit eine entsprechend erweiterte Standardfunktion bietet.

Ein in der Praxis erprobtes Verfahren für das Löschen von beliebig großen Seitenhierarchien nutzt andere Standardfunktionen von Confluence und schafft Abhilfe, wo die neue Standardfunktion noch nicht verfügbar ist.

Continue reading

Eine Produktdokumentation für ein erfolgreiches Software-Produkt wird über eine lange Zeit gepflegt. Hygiene ist darum sehr wichtig. Wie Entwickler toten Code identifizieren und entfernen, so muss jeder Autor darauf achten, Inhalte zu entfernen, die nicht mehr gültig sind. Zur Erhaltung der Qualität der Produktdokumentation muss er manchmal ganze Seiten löschen. Im Bereich der kurzlebigen Projektdokumentation (z.B. Besprechungsprotokolle, Analyseergebnisse, Statusübersichten, Berichte an das Management) passiert es immer wieder, dass Links auf Seiten der Produktdokumentation existieren, die ein Autor löschen will.

Die folgenden Standardfunktionen von Confluence werden zu einem einfachen Workflow für sicheres Löschen kombiniert. Damit kann ein Autor sicher feststellen, dass eine Seite nicht mehr aktiv genutzt wird. Falls es eine Verknüpfung gibt, kann er herausfinden, in welcher anderen Seite sich dieser Link befindet. So kann er andere Autoren informieren, bevor er seine Seite löscht.

Continue reading