CARDS+

Category: Confluence (page 1 of 2)

Confluence-Tip Seitentitel mit Präfix

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.

ktip 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

Confluence-Tip Seitenhierarchie löschen

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.

Bereiche sind die Methode von Confluence, Inhalte in sinnvolle Einheiten zu organisieren. Das Anlegen eines Bereiches (Space) geht einfach und schnell, erfordert aber besondere Rechte.

Weiterlesen auf atlassian.com

Jeder Bereich (Space) kann in den Formaten XML, HTML oder PDF exportiert werden. Die Durchführung dieser Operation erfordert aber besondere Rechte.

Nur ein XML-Export kann aber später wieder importiert werden.

Weiterlesen auf atlassian.com

Ein Bereich (Space) kann mit allen Inhalten gelöscht werden. Diese Operation ist aber endgültig und erfordert besondere Rechte.

Weiterlesen auf atlassian.com

Bereiche (Spaces), die als XML-Export vorliegen, können wieder importiert werden. Die Durchführung dieser Operation erfordert aber besondere Rechte.

Weiterlesen auf atlassian.com

Eine Seite wird in Confluence verschoben, indem die übergeordnete Seite geändert wird. Anders als beim Löschen einer Seiten werden mit der Seite auch alle Unterseiten verschoben.

Weiterlesen auf atlassian.com

Continue reading

Confluence-Tip Seiten sicher löschen

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.

Ein Seite kann in Confluence ganz leicht von jedem Nutzer gelöscht werden, der das Recht zum Bearbeiten der Seite hat. Sie werden von Confluence nicht endgültig gelöscht, sondern in den Papierkorb (trash) verschoben. Die Seite ist danach für Nutzer nicht mehr sichtbar. Gelöschte Seiten können aus dem Papierkorb von einem Nutzer wieder hergestellt werden. Das geht nur solange, bis der Papierkorb manuell geleert wird.

Weiterlesen auf atlassian.com

Eine Seite wird in Confluence verschoben, indem die übergeordnete Seite geändert wird. Anders als beim Löschen einer Seiten werden mit der Seite auch alle Unterseiten verschoben.

Weiterlesen auf atlassian.com

Verwaiste Seiten (orphaned pages) sind Seiten ohne übergeordnete Seite. Sie sind in der normalen Ansicht von Confluence für den Nutzer nicht sichtbar.

Weiterlesen auf atlassian.com

Der Zugriff auf Seiten (page restriction) kann in Confluence einfach und schnell beschränkt werden.

Weiterlesen auf atlassian.com

Continue reading

Confluence-Tip Seiteninformationen nutzen

Ein Wiki lebt von der Dynamik in den Inhalten. Leser erwarten von den Autoren, dass Informationen im Wiki optimal aufbereitet sind. Zusammenhänge sind wichtig, gleiches Wissen wird an unterschiedlichen Stellen vermittelt. Die große Gefahr bei einem Wiki ist das Kopieren von Inhalten. Genau wie eine Papierkopie ist eine kopierte Information falsch oder veraltet, sobald sich die originale Information ändert. Confluence bietet darum eine Reihe von Funktionen, mit denen Seiten miteinander verknüpft werden. Aber was noch viel wichtiger ist: Confluence bietet auch eine Funktion, um den Überblick über die Verknüpfungen zu behalten.

Der einfachste Fall einer Verknüpfung (Link) von zwei Seiten in Confluence. Ein Link ist ein farblich hervorgehobener Text. Durch Klick auf den Link wird ein Leser auf die andere Seite geleitet.

Weiterlesen auf atlassian.com

Das Makro “Seiten einschließen” (“Include Page”) ist die elegante Variante einer Verknüpfung zweier Seiten in Confluence. Ohne zusätzlichen Klick sieht ein Leser einen Text oder ein Bild an verschiedenen Stellen. Der Autor muss den Inhalt aber nur an einer einzigen Stelle pflegen.

Weiterlesen auf atlassian.com

Continue reading

Confluence-Tip Stichworte nutzen

Eine wachsende Menge an Seiten in unserem Wiki führt dazu, dass die Baumstruktur in Confluence unübersichtlich wird. Stichworte, richtig verwendet, sind sie ein sehr leistungsfähiges Mittel, um Seiten im Wiki schnell und sicher zu finden, zusätzlich zur Navigation in der Baumstruktur. Stichworte stellen neben Kommentaren und dem Gefällt-Mir-Status sehr nützliche Zusatzinformationen einer Seite im Wiki dar. Stichworte können praktisch in beliebiger Anzahl verwendet werden.

ktip Atlassian hat den englischen Begriff “label” in den deutschen Begriff “Stichwort” übersetzt. Das ist meiner Meinung nicht ganz optimal. Stichworte sind in der üblichen Definition Teil des Textes oder Titels einer Seite. Schlagworte hingegen sind Zusatzinformationen aus einem kontrollierten Vokabular. Schlagworte müssen aber nicht zwingend im Text oder Titel der Seite vorkommen. Schlagwort trifft daher den Kern der Sache besser.

Continue reading

Confluence-Tip Kontinuierliche Verbesserung organisieren

Scrum nennt es “inspect and adopt”. KCS hat einen “double loop process”. In vielen Unternehmen gibt es den kontinuierlichen Verbesserungsprozess (kurz KVP). In allen Fällen steckt dahinter der Gedanke, dass dauerhaft gute Qualität das Ergebnis permanenter Verbesserung ist. Jeder Mitarbeiter trägt seinen Anteil bei. Diese kontinuierliche Verbesserung will organisiert sein.

Confluence hat eine ganze Reihe von Funktionen zur Unterstützung und Verbesserung der Zusammenarbeit von Autoren und Lesern.

Ein Autor kann eine Seite mit bestimmten Lesern teilen oder Beobachter der Seite über eine Änderung informieren. Jeder Leser kann Seiten kommentieren, mit “Gefällt mir” markieren oder beobachten.

Weiterlesen auf atlassian.com

Seitenkommentare werden zeitlich geordnet im Anschluss an die Seite gezeigt. Seitenkommentare können auch beantwortet werden und bilden so eine Diskussion.

Weiterlesen auf atlassian.com

Textkommentare sind eine sehr elegante Möglichkeit, wie ein Leser Feedback zu einem bestimmten Wort oder Satz geben kann. Er muss die Textstelle nur markieren und seinen Kommentar hinzufügen.

Weiterlesen auf atlassian.com

Continue reading

Confluence-Tip Kommentare moderieren

Die Produktdokumentation ist ein Ergebnis des ganzen Teams. Der Product-Owner, unterstützt von Business-Analysten, beginnt mit dem fachlichen Entwurf. Zusammen mit dem Team ergänzt er die Lösung im Rahmen der Software-Architektur. Jeder Analyst, Entwickler und Tester im Team hat Anteil an einer guten Dokumentation. Er korrigiert Fehler, kommentiert Unklarheiten oder macht Vorschläge für Verbesserungen, mit Kommentaren direkt im Wiki.

Confluence bietet zwei Wege, wie Leser Kommentare hinterlassen können.

Seitenkommentare werden zeitlich geordnet im Anschluss an die Seite gezeigt. Seitenkommentare können auch beantwortet werden und bilden so eine Diskussion.

Weiterlesen auf atlassian.com

Textkommentare sind eine sehr elegante Möglichkeit, wie ein Leser Feedback zu einem bestimmten Wort oder Satz geben kann. Er muss die Textstelle nur markieren und seinen Kommentar hinzufügen.

Weiterlesen auf atlassian.com

Continue reading

Confluence-Tip Berechtigungen nutzen

Confluence unterscheidet drei Arten von Berechtigungen: Globale Berechtigungen, bereichsbezogene Berechtigungen und Seitenberechtigungen. Berechtigungen gelten in der Regel für ganze Nutzergruppen. Im Einzelfall werden Seitenberechtigungen auch an einzelne Nutzer vergeben. Berechtigungen können erteilt, aber nicht explizit entzogen werden. Ein einzelner Nutzer kann darum niemals ausgeschlossen werden, wenn er Mitglied einer Nutzergruppe ist, die berechtigt ist.

Das Berechtigungskonzept von Confluence ist durchdacht und für viele Anwendungsfälle sehr gut geeignet. Sebastian Höhne gibt in seinem Blog einen guten Überblick.

Weiterlesen auf sebastian-hoehne.de

Wie einfach und schnell in Confluence ein neuer Bereich angelegt und mit Zugriffsrechten ausgestattet werden kann zeigt ein kurzen Video:

Anschauen auf youtu.be

Seiten in Confluence können einfach und schnell mit Zugriffsrechten zum Lesen und Bearbeiten ausgestattet werden. Ein kurzes Video zeigt, wie es geht.

Anschauen auf youtu.be

Continue reading

Confluence-Tip UML mit Enterprise Architect im Griff haben

Enterprise Architect von Sparx Systems (kurz EA) ist ein Werkzeug für Analyse und Design mit der Unified Modelling Language (kurz UML). UML ist eine Sprache zur Beschreibung technischer Systeme und hilft konsistente und nachvollziehbare Modelle des Systems zu erstellen. EA stellt dabei eine benutzerfreundliche und flexible Modellierungsumgebung zur Verfügung. EA wird immer dann eingesetzt, wenn UML-Diagramme nicht mehr trivial sind. Nur mit einem Werkzeug wie dem EA ist es möglich, Elemente des Modells konsistent in vielen verschiedenen Diagrammen zu verwenden. Nur so kann mit vertretbaren Aufwand eine Konsistenz in einem komplexen Modell sichergestellt werden.

Das Add-On “EA Connector for Confluence” ist ein Werkzeug, mit dem ein EA-Modell in wenigen Schritten für Confluence schnell und sicher verfügbar gemacht wird.

Weiterlesen auf atlassian.com

Einen anderen Ansatz beschreibt Per Spilling in seinem Blog. Mit einem API des EA ist es möglich, ein ganzes Modell zu exportieren und so für das Wiki verfügbar zu machen. Die PNG-Dateien tragen den Namen des Diagramms, die Ordnerstruktur folgt der Struktur des Modells im EA.

Weiterlesen auf perspilling.net

Continue reading

Confluence-Tip Abbildungen mit Powerpoint erstellen

Powerpoint ist ein sehr beliebtes Werkzeug im Projektmanagement. Auch in der Anforderungsanalyse wird Powerpoint gerne verwendet. Personas beispielsweise sind fiktive Personen, die typische Anwender einer Zielgruppe repräsentieren. Sie verdeutlichen wichtige Eigenschaften der Zielgruppen. Sie sind eine schöne Ergänzung für Epics. Mit Powerpoint können wir schön gestaltete Steckbriefe für unsere Persona erstellen. Ein weiteres Anwendungsgebiet für Powerpoint ist die Erstellung von Abbildungen, die einen Überblick über Topics oder Epics geben (z.B. als Mindmap). Es gibt sicher noch viele weitere sinnvolle Einsatzmöglichkeiten. Powerpoint-Dateien können sehr einfach in Confluence angezeigt und bearbeitet werden. Einer Verwendung von Powerpoint für die Gestaltung von Abbildungen in der Produktdokumentation steht also nichts im Weg.

Confluence bietet bereits von Haus aus drei Möglichkeiten an.

  • Direkte Anzeige einer Powerpoint-Datei mit dem Office-Connector
  • Konvertierung in eine PDF-Datei und Anzeige mit dem PDF-Makro
  • Konvertierung in eine PNG/JPEG-Datei und Anzeige mit dem Galerie-Makro

Weiterlesen auf atlassian.com

Das Powerpoint-Makro zeigt den Inhalt einer Powerpoint-Datei direkt in der Seite an. Leider wird das Makro in zukünftigen Releases nicht mehr unterstützt werden.

Weiterlesen auf atlassian.com

Continue reading

Olderposts

Copyright © 2018 Impressum Datenschutz

Zum Anfang ↑