{"id":76463,"date":"2020-04-02T13:42:40","date_gmt":"2020-04-02T11:42:40","guid":{"rendered":"https:\/\/prohoster.info\/blog\/administrirovanie\/proektirovanie-v-confluence"},"modified":"2020-04-02T13:42:40","modified_gmt":"2020-04-02T11:42:40","slug":"proektirovanie-v-confluence","status":"publish","type":"post","link":"https:\/\/prohoster.info\/de\/blog\/administrirovanie\/proektirovanie-v-confluence","title":{"rendered":"Projektierung in Confluence","gt_translate_keys":[{"key":"rendered","format":"text"}]},"content":{"rendered":"

Hallo zusammen! <\/p>\n

Mein Name ist Masha und ich arbeite als QA-Ingenieurin bei der Tinkoff-Gruppe. Die Arbeit im QA-Bereich erfordert zahlreiche Kommunikationen mit verschiedenen Personen aus unterschiedlichen Teams. Zudem war ich auch Managerin und Dozentin f\u00fcr Bildungsprogramme, weshalb mein Kommunikationsnetzwerk sehr weitreichend war. Irgendwann habe ich einfach aufgegeben: Ich konnte einfach nicht mehr, ich konnte nicht mehr diese unlesbaren Tabellen und Dokumente ausf\u00fcllen. <\/p>\n

\"Projektierung
\n
\n<\/a><\/noindex>
\nSicherlich hat sich jeder von Ihnen jetzt das vorgestellt, wor\u00fcber ich spreche, und einen kalten Schwei\u00dfausbruch bekommen: Listen von Nachnamen ohne alphabetische Ordnung, Tabellen mit Hunderten von Spalten, bei denen das Layout verschoben ist, Tabellen mit Tausenden von Zeilen, bei denen man seinen Finger \u00fcber das Mausrad reiben muss, um die \u00dcberschrift zu sehen, Tonnen von unnummerierten Anleitungen, Hunderte von E-Mails, die hin und her geschickt werden mit Daten, die man analysieren, systematisieren und in ebenso unlesbare Tabellen stopfen muss.<\/p>\n

\"Projektierung
\n
\nUnd nachdem ich etwas abgek\u00fchlt bin, habe ich mich entschieden, diesen Artikel zu schreiben. Ich m\u00f6chte dar\u00fcber berichten, wie man vern\u00fcnftige (und manchmal sogar praktische) nicht-produktbezogene Dokumentation f\u00fchren kann. Ich hoffe, dass der Artikel im Netz verbreitet wird und das Niveau des Chaos in den Abteilungen neben der Entwicklung ein wenig sinkt, sodass die Menschen (einschlie\u00dflich mir) etwas gl\u00fccklicher werden.<\/p>\n

\"Projektierung
\n<\/p>\n

Werkzeuge<\/h2>\n

\nProduktbezogene Dokumentation wird oft neben dem Code aufbewahrt, was gut ist. Nicht-produktbezogene Dokumentation hingegen wird oft irgendwo abgelegt. H\u00e4ufig versuchen die Leute, Informationen aus verschiedenen Quellen in Confluence zu \u00fcbertragen, und wir sind da keine Ausnahme. Daher wird der folgende Bericht dar\u00fcber sein.<\/p>\n

Im Allgemeinen ist Confluence eine fortschrittliche Wiki-Engine. Sie erm\u00f6glicht die Arbeit mit Daten in verschiedenen Darstellungsformen: formatierter Text, Tabellen, verschiedene Diagramme. Es ist ein sehr interessantes und m\u00e4chtiges Werkzeug, aber wenn man nicht wei\u00df, wie man es richtig einsetzt, hat man am Ende einen Haufen unleserlicher Dokumente. Ich werde euch beibringen, wie man es richtig macht!<\/p>\n

\"Projektierung
\n<\/p>\n

Makros<\/h2>\n

\nDie Hauptmagie von Confluence basiert auf Makros. Es gibt viele verschiedene Makros, die miteinander kombiniert werden k\u00f6nnen. Sie k\u00f6nnen kostenpflichtig oder kostenlos sein; im Folgenden finden Sie verschiedene Beispiele f\u00fcr Makros mit Links zur entsprechenden Dokumentation.<\/p>\n

Die Benutzeroberfl\u00e4che f\u00fcr die Arbeit mit Makros ist \u00e4u\u00dferst einfach. Um ein Makro hinzuzuf\u00fcgen, klicken Sie auf das Pluszeichen und w\u00e4hlen Sie das gew\u00fcnschte Element aus der Liste.<\/p>\n

\"Projektierung
\n
\nWenn ein Makro eigenst\u00e4ndig ist, d. h. nichts weiter in sich ben\u00f6tigt, erscheint es als Block.<\/p>\n

\"Projektierung
\n
\nWenn f\u00fcr die Funktion eines Makros etwas innerhalb platziert werden muss, wird es als Rahmen dargestellt.<\/p>\n

\"Projektierung
\n
\nInnerhalb eines Rahmens k\u00f6nnen Sie beliebig viele andere Elemente unterbringen, solange Ihre Struktur logisch bleibt.<\/p>\n

\"Projektierung
\n
\nJedes Makro verf\u00fcgt \u00fcber eine Vorschau: So sehen Sie sofort, ob Sie das Makro korrekt ausgef\u00fcllt und konfiguriert haben.<\/p>\n

Vorlagen<\/h2>\n

\nZus\u00e4tzlich zu den Makros gibt es ein hilfreiches Tool zur automatischen Bef\u00fcllung von Inhalten \u2013 die Vorlage.
\nVorlagen k\u00f6nnen beim Erstellen jeder Seite verwendet werden: Klicken Sie einfach auf die drei Punkte neben der Schaltfl\u00e4che \u201eErstellen\u201c und w\u00e4hlen Sie die gew\u00fcnschte Vorlage aus.<\/p>\n

\"Projektierung
\n
\nDann wird der gesamte Inhalt, der in der Vorlage steht, in die neu erstellte Seite eingef\u00fcgt.<\/p>\n

Seiten aus Vorlagen kann jeder erstellen, jedoch k\u00f6nnen nur die Personen, die entsprechende Rechte haben, die Vorlagen selbst erstellen oder bearbeiten. In die Vorlage k\u00f6nnen zus\u00e4tzliche Anweisungen hinzugef\u00fcgt werden, wie die Seite gef\u00fchrt werden soll.<\/p>\n

\"Projektierung
\n<\/p>\n

Die Magie der Tabellen<\/h2>\n

\nAls Techniker habe ich eine besondere Vorliebe f\u00fcr Tabellen; ich kann fast jede Information darin unterbringen (auch wenn das nicht immer die effektivste Methode ist). Tabellen sind klar, strukturiert, skalierbar und einfach magisch!<\/p>\n

\"Projektierung
\n
\nDoch selbst so eine wunderbare Sache wie eine Tabelle kann vermasselt werden. Man kann sie jedoch auch geschickt nutzen und sogar verbessern. Mehr dazu weiter unten.<\/p>\n

Filterung (kostenpflichtiges Plugin)<\/h3>\n

\nJede riesige, unleserliche Tabelle kann durch Filterung etwas weniger riesig und lesbarer gemacht werden. Daf\u00fcr kann ein kostenpflichtiges Makro verwendet werden. \u201eTabellenfilter\u201c<\/a><\/noindex>.<\/p>\n

In dieses Makro muss die Tabelle eingef\u00fcgt werden (selbst die h\u00e4sslichste ist in Ordnung, solange sie vollst\u00e4ndig eingef\u00fcgt wird). Im Makro k\u00f6nnen Spalten f\u00fcr Filter mittels Dropdown-Liste, Textfilter, Zahlenfilter und Datumsfilter ausgew\u00e4hlt werden. <\/p>\n

\"Projektierung
\n
\nStellen Sie sich vor, dass alle Informationen zu den Bewerbern f\u00fcr alle Stellenangebote in einer unsortierten Tabelle festgehalten werden. Nat\u00fcrlich kommen die Leute nicht alphabetisch zu den Vorstellungsgespr\u00e4chen. Sie m\u00fcssen nur herausfinden, ob Sie bereits ein Gespr\u00e4ch mit einem bestimmten Kandidaten gef\u00fchrt haben. Dazu bringen Sie einfach das Chaos in ein Filter-Makro, f\u00fcgen einen Textfilter nach Nachname hinzu \u2013 und voil\u00e0, die Informationen sind auf Ihrem Bildschirm.<\/p>\n

\"Projektierung
\n
\nEs ist wichtig zu beachten, dass die Filterung gro\u00dfer Tabellen die Systemleistung und die Ladezeiten der Seiten beeintr\u00e4chtigen kann. Daher ist es eine vor\u00fcbergehende L\u00f6sung, eine gro\u00dfe Tabelle zu filtern. Es ist besser, einen Prozess aufzubauen, in dem die Leute keine riesigen, unleserlichen Tabellen erstellen m\u00fcssen (ein Beispiel f\u00fcr diesen Prozess finden Sie am Ende des Artikels).<\/p>\n

Sortierung (kostenpflichtiges Plugin)<\/h3>\n

\nMit einem magischen Makro \u201eTabellenfilter\u201c<\/a><\/noindex> kann auch eine Standard-Sortierung nach beliebiger Spalte festgelegt und die Zeilen nummeriert werden. Oder Sie klicken auf eine beliebige Spalte der Tabelle, die im Filter-Makro enthalten ist, und sie wird nach dieser Spalte sortiert. <\/p>\n

\"Projektierung
\n
\nZum Beispiel, wenn Sie dieselbe Tabelle mit Bewerbern haben und herausfinden m\u00f6chten, wie viele Interviews in einem bestimmten Monat gef\u00fchrt wurden, sortieren Sie nach Datum und freuen Sie sich.<\/p>\n

Pivot-Tabellen (kostenpflichtiges Plugin)<\/h3>\n

\nJetzt kommen wir zu einem interessanteren Fall. Stellen Sie sich vor, Ihre Tabelle ist riesig und Sie m\u00fcssen etwas damit berechnen. Nat\u00fcrlich k\u00f6nnen Sie sie nach Excel kopieren, die ben\u00f6tigten Berechnungen durchf\u00fchren und die Daten zur\u00fcck in Confluence exportieren. Oder Sie verwenden einmalig ein Makro. \u201ePivot-Tabelle\u201c<\/a><\/noindex> und erhalten das gleiche Ergebnis, aber zus\u00e4tzlich aktualisierbar.<\/p>\n

Beispiel: Sie haben eine Tabelle, die Daten aller Mitarbeiter enth\u00e4lt \u2013 wo sie sich geografisch befinden und welche Positionen sie innehaben. Um zu z\u00e4hlen, wie viele Personen in jeder Stadt sind, m\u00fcssen Sie im Makro \u201ePivot-Tabelle\u201c die Zeile ausw\u00e4hlen, nach der die Daten aggregiert werden (Standort) und die Art der Operation (Addition).<\/p>\n

\"Projektierung
\n
\nNat\u00fcrlich kann man nach mehreren Kriterien gleichzeitig gruppieren; alle M\u00f6glichkeiten k\u00f6nnen angesehen werden. in der Dokumentation<\/a><\/noindex>.<\/p>\n

Diagramme (kostenpflichtiges Plugin)<\/h3>\n

\nWie ich bereits sagte, m\u00f6gen nicht alle Tabellen so sehr wie ich. Leider haben die meisten Manager eine Abneigung gegen sie. Aber alle lieben auff\u00e4llige, bunte Diagramme.
\nDie Entwickler von Confluence waren sich dessen sicherlich bewusst (sie haben bestimmt auch Vorgesetzte, die Berichte und Diagramme m\u00f6gen, wo k\u00e4men wir da hin). Deshalb kann man den magischen Makro verwenden, \u201eDiagramm aus Tabelle\u201c<\/a><\/noindex>. In dieses Makro muss man die Pivot-Tabelle aus dem vorherigen Punkt einf\u00fcgen, und voila \u2014 Ihre grauen, langweiligen Daten sind sch\u00f6n visualisiert.<\/p>\n

\"Projektierung
\n
\nNat\u00fcrlich gibt es auch in diesem Makro Einstellungen. Den Link zur Dokumentation jedes Makros finden Sie im Bearbeitungsmodus dieses Makros.<\/p>\n

Einfachheit der Aggregation<\/h2>\n

\nDie Informationen aus den vorherigen Punkten waren Ihnen sicherlich keine \u00dcberraschung. Aber jetzt wissen Sie genau, wie man Makros verwendet, und ich kann zu dem interessanteren Teil des Artikels \u00fcbergehen.<\/p>\n

\"Projektierung
\n<\/p>\n

Kennzeichnungen<\/h3>\n

\nEs ist ineffizient, wenn Informationen in einem unstrukturierten Artikel oder einer riesigen Tabelle aufbewahrt werden. Noch schlimmer ist es, wenn Teile dieser Informationen nicht nur unleserlich formatiert sind, sondern auch verstreut in Confluence zu finden sind. Gl\u00fccklicherweise gibt es die M\u00f6glichkeit, verstreute Informationen an einem Ort zu sammeln. Dazu sollten Sie die Tags<\/a><\/noindex> (allen aus sozialen Netzwerken bekannten Etiketten) verwenden.<\/p>\n

\"Projektierung
\n
\nAuf jede Seite k\u00f6nnen beliebig viele Tags hinzugef\u00fcgt werden. Wenn Sie auf einen Tag klicken, gelangen Sie zu einer Aggregationsseite, auf der Links zu allen Materialien mit diesem Tag sowie zu einer Reihe verwandter Tags zu finden sind. Verwandte Tags sind solche, die h\u00e4ufig auf derselben Seite vorkommen.<\/p>\n

\"Projektierung
\n<\/p>\n

Seitenattribute<\/h3>\n

\nZus\u00e4tzlich k\u00f6nnen Sie ein interessantes Makro hinzuf\u00fcgen, um Informationen zu strukturieren \u2014 \u201eSeitenattribute\u201c<\/a><\/noindex>. In dieses Makro m\u00fcssen Sie eine Tabelle mit zwei Spalten einf\u00fcgen, wobei die erste die Schl\u00fcssel und die zweite den Wert des Attributs sein wird. Dabei kann das Makro von der Seite ausgeblendet werden, sodass es den Lesefluss nicht st\u00f6rt, aber die Seite dennoch mit den erforderlichen Schl\u00fcsseln versehen bleibt.<\/p>\n

\"Projektierung
\n
\nBitte beachten Sie die ID \u2013 es ist praktisch, diese zu vergeben, um unterschiedliche Eigenschaften verschiedenen Seiten (oder sogar unterschiedlichen Gruppen von Eigenschaften auf einer Seite) zuzuordnen. <\/p>\n

Berichte<\/h3>\n

\nBerichte k\u00f6nnen anhand von Tags erstellt werden. Zum Beispiel makros \u201eInhaltsbericht\u201c<\/a><\/noindex> sammelt alle Seiten mit einem bestimmten Set von Tags.<\/p>\n

\"Projektierung
\n
\nEin interessanterer Bericht ist jedoch das Makro \u201eSeitenattributbericht\u201c<\/a><\/noindex>. Es sammelt ebenfalls alle Seiten mit einem bestimmten Satz an Tags, listet diese jedoch nicht einfach auf, sondern erstellt eine Tabelle (erinnern Sie sich an den Zusammenhang mit dem Anfang des Artikels?), in der die Spalten die Schl\u00fcssel der Seitenattribute darstellen.<\/p>\n

\"Projektierung
\n
\nDas Ergebnis ist eine Pivot-Tabelle, die Informationen aus verschiedenen Quellen zusammenfasst. Praktisch ist, dass sie n\u00fctzliche Funktionen hat: responsives Design, Sortierung nach beliebigen Spalten. Solch eine Berichtstabelle kann auch innerhalb des Makros konfiguriert werden. <\/p>\n

\"Projektierung
\n
\nBei der Konfiguration k\u00f6nnen bestimmte Spalten aus dem Bericht entfernt, der Standardzustand oder die Anzahl der angezeigten Elemente festgelegt werden. Au\u00dferdem kann die Seitenattribut-ID angegeben werden, um nur die relevanten Informationen anzuzeigen.<\/p>\n

Zum Beispiel haben Sie eine Vielzahl von Mitarbeiterseiten, und auf diesen Seiten gibt es eine Reihe von Eigenschaften \u00fcber die Person: welches Niveau sie hat, wo sie sich befindet, wann sie ins Team gekommen ist usw. Diese Eigenschaften sind gekennzeichnet ID = employee_inf<\/i>. Und es gibt einen zweiten Satz von Eigenschaften auf derselben Seite, die Informationen \u00fcber die Person als Teil des Teams sammeln: welche Rolle die Person ausf\u00fcllt, in welchem Team sie sich befindet usw. Diese Eigenschaften sind gekennzeichnet ID = team_inf<\/i>. Dann k\u00f6nnen Sie beim Erstellen des Berichts entweder nur Informationen zu einer ID oder gleich zu zwei IDs ausgeben \u2013 je nachdem, was praktischer ist.<\/p>\n

Das Sch\u00f6nste an diesem Ansatz ist, dass jeder die f\u00fcr ihn ben\u00f6tigte Informationstabelle erstellen kann, die nichts dupliziert und sich beim Aktualisieren der Hauptseite aktualisiert. Zum Beispiel: Ein Teamleiter interessiert sich nicht daf\u00fcr, wann seine Entwickler eingestellt wurden, sondern daf\u00fcr, welche Rolle jeder von ihnen im Team spielt. Der Teamleiter wird einen Bericht f\u00fcr sein Team zusammenstellen. Ein Buchhalter interessiert sich \u00fcberhaupt nicht daf\u00fcr, wer welche Rolle spielt, aber die Positionen sind wichtig \u2013 er wird sich einen Bericht \u00fcber die Positionen zusammenstellen. Dabei wird die Informationsquelle nicht dupliziert oder verschoben.<\/p>\n

Der abschlie\u00dfende Prozess<\/h2>\n

<\/p>\n

Anleitung<\/h3>\n

\nSo k\u00f6nnen wir Informationen in Confluence sch\u00f6n strukturieren und effizient aggregieren, indem wir Makros verwenden. Idealerweise sollte neue Informationen direkt strukturiert werden und in alle bereits genutzten Aggregationsmechanismen integriert werden.<\/p>\n

Hier kommt die Kombination aus Makros und Vorlagen ins Spiel. Um die Benutzer dazu zu bringen, neue Seiten im gew\u00fcnschten Format zu erstellen, kann das Makro \u201eAus Vorlage erstellen\u201c verwendet werden. Es f\u00fcgt der Seite einen Button hinzu, durch den beim Klicken eine neue Seite aus der gew\u00e4hlten Vorlage erstellt wird. So stellen Sie sicher, dass die Nutzer sofort im gew\u00fcnschten Format arbeiten. <\/p>\n

\"Projektierung
\n
\nIn die Vorlage, aus der Sie die Seite erstellen, sollten Sie im Voraus Tags, das Makro \u201eSeitenattribute\u201c und eine Tabelle mit den ben\u00f6tigten Attributen einf\u00fcgen. Ich empfehle zudem, Anleitungen hinzuzuf\u00fcgen, welche Werte ausgef\u00fcllt werden sollten und welche Eigenschaften verwendet werden.<\/p>\n

\"Projektierung
\n
\nDer gesamte Prozess w\u00fcrde dann wie folgt aussehen:<\/p>\n

    \n
  1. Sie erstellen eine Vorlage f\u00fcr Informationen eines bestimmten Typs.<\/li>\n
  2. In diese Vorlage f\u00fcgen Sie Tags und Seitenattribute im Makro ein.<\/li>\n
  3. An einer beliebigen Stelle erstellen Sie eine Hauptseite mit einem Button, der beim Klicken eine Unterseite aus der Vorlage generiert. <\/li>\n
  4. Sie lassen Benutzer auf die Hauptseite, die potenziell die ben\u00f6tigten Informationen generieren k\u00f6nnen (im gew\u00fcnschten Format durch Klicken auf den Button).<\/li>\n
  5. Sie erstellen sich einen Bericht \u00fcber die Eigenschaften der Seite anhand der Tags, die Sie in der Vorlage angegeben haben.<\/li>\n
  6. Sie freuen sich: Sie haben alle ben\u00f6tigten Informationen in einem praktischen Format. <\/li>\n<\/ol>\n

    \"Projektierung
    \n<\/p>\n

    Herausforderungen<\/h3>\n

    \nAls Qualit\u00e4tsingenieur kann ich mit Zuversicht sagen, dass es nichts Perfektes auf der Welt gibt. Selbst g\u00f6ttliche Tabellen sind nicht perfekt. Und im oben beschriebenen Prozess gibt es einige Fallstricke.<\/p>\n