{"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":"Entwurf in Confluence","gt_translate_keys":[{"key":"rendered","format":"text"}]},"content":{"rendered":"

Hallo zusammen! <\/p>\n

Ich hei\u00dfe Masha und arbeite als Qualit\u00e4tsingenieurin in der Tinkoff Unternehmensgruppe. Die QA-Arbeit erfordert viele Kommunikationen mit verschiedenen Leuten aus unterschiedlichen Teams, und ich war au\u00dferdem Managerin und Dozentin f\u00fcr Bildungsprogramme, weshalb mein Kommunikationsnetz maximal weit gef\u00e4chert war. Und irgendwann war ich so frustriert: Ich habe erkannt, dass ich es nicht mehr ertragen kann, unz\u00e4hlige unleserliche Tabellen und Dokumente auszuf\u00fcllen. <\/p>\n

\"Entwurf
\n
\n<\/a><\/noindex>
\nWahrscheinlich hat sich jeder von euch jetzt das vorgestellt, wor\u00fcber ich spreche, und ist ins Schwitzen geraten: Listen von Nachnamen ohne alphabetische Reihenfolge, Tabellen mit Hunderten von Spalten mit verschobener Formatierung, Tabellen mit Tausenden von Zeilen, bei denen man seinen Finger am Mausrad reiben muss, um die \u00dcberschrift zu sehen, Tonnen von unnummerierten Anleitungen, Hunderte von weitergeleiteten E-Mails mit Daten, die analysiert und systematisiert und in ebenso unleserliche Tabellen gesteckt werden m\u00fcssen.<\/p>\n

\"Entwurf
\n
\nUnd als ich mich etwas beruhigt hatte, beschloss ich, diesen Artikel zu schreiben. Ich m\u00f6chte dar\u00fcber berichten, wie man normale (manchmal sogar bequeme) nicht-produktbezogene Dokumentation f\u00fchrt. Ich hoffe, dass der Artikel sich im Netz verbreitet und das Niveau des Chaos in den Abteilungen, die mit Entwicklung zusammenh\u00e4ngen, zumindest ein wenig sinkt, und die Leute (mich eingeschlossen) ein kleines bisschen gl\u00fccklicher werden.<\/p>\n

\"Entwurf
\n<\/p>\n

Werkzeuge<\/h2>\n

\nProduktdokumentation wird oft direkt neben dem Code aufbewahrt, was gut ist. Nicht-produktbezogene Dokumentation wird normalerweise irgendwo hinterlegt. Oft versuchen die Leute, Informationen aus verschiedenen Quellen nach Confluence zu \u00fcbertragen, und wir sind keine Ausnahme. Daher handelt die gesamte folgende Erz\u00e4hlung davon.<\/p>\n

Im Grunde ist Confluence eine erweiterte Wiki-Engine. Sie erm\u00f6glicht die Arbeit mit Daten in verschiedenen Darstellungsformen: formatierter Text, Tabellen, verschiedene Diagramme. Es ist ein sehr interessantes und leistungsstarkes Werkzeug, aber wenn man nicht wei\u00df, wie man es vorbereitet, erh\u00e4lt man eine weitere Ablage unleserlicher Dokumente. Ich werde euch beibringen, wie man das richtig macht!<\/p>\n

\"Entwurf
\n<\/p>\n

Makros<\/h2>\n

\nFast die gesamte Magie von Confluence beruht auf Makros. Es gibt viele Makros, und sie k\u00f6nnen miteinander kombiniert werden. Es gibt kostenpflichtige und kostenlose, und im Folgenden werden verschiedene Beispiele f\u00fcr Makros mit Links zur Dokumentation vorgestellt.<\/p>\n

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

\"Entwurf
\n
\nWenn das Makro autark ist, d. h. nichts anderes in sich einf\u00fcgen muss, sieht es wie ein Block aus.<\/p>\n

\"Entwurf
\n
\nWenn f\u00fcr die Funktion des Makros etwas hineingelegt werden muss, sieht es wie ein Rahmen aus.<\/p>\n

\"Entwurf
\n
\nDabei kann man beliebig viele andere innerhalb eines Rahmens unterbringen, solange in Ihrer Pyramide eine Logik vorhanden ist.<\/p>\n

\"Entwurf
\n
\nJedes Makro hat eine Vorschau: darin sieht man sofort, ob man das Makro richtig ausgef\u00fcllt und eingestellt hat.<\/p>\n

Vorlagen<\/h2>\n

\nNeben Makros gibt es ein n\u00fctzliches Werkzeug f\u00fcr die automatische Bef\u00fcllung von Inhalten \u2013 das ist die Vorlage.
\nVorlagen k\u00f6nnen bei der Erstellung jeder Seite verwendet werden: einfach auf die drei Punkte neben der Schaltfl\u00e4che \u201eErstellen\u201c klicken und die gew\u00fcnschte Vorlage ausw\u00e4hlen.<\/p>\n

\"Entwurf
\n
\nDann wird der gesamte Inhalt, der in der Vorlage enthalten ist, in die erstellte Seite eingef\u00fcgt.<\/p>\n

Jeder kann Seiten aus Vorlagen erstellen, aber nur diejenigen mit den entsprechenden Rechten k\u00f6nnen die Vorlagen selbst erstellen oder bearbeiten. In die Vorlage k\u00f6nnen zus\u00e4tzliche Anweisungen aufgenommen werden, wie die Seite gef\u00fchrt werden soll.<\/p>\n

\"Entwurf
\n<\/p>\n

Die Magie der Tabellen<\/h2>\n

\nTats\u00e4chlich liebe ich als Techniker Tabellen und kann fast jede Information darin unterbringen (auch wenn das nicht immer effizient ist). Tabellen selbst sind klar, strukturiert, skalierbar, magisch!<\/p>\n

\"Entwurf
\n
\nAber selbst eine so wunderbare Entit\u00e4t wie eine Tabelle kann verderben werden. Man kann sie aber auch geschickt nutzen und sogar verbessern. Darum geht es im Folgenden.<\/p>\n

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

\nJede gro\u00dfe, unleserliche Tabelle kann durch Filterung etwas weniger gro\u00df und etwas leserlicher gemacht werden. Daf\u00fcr kann man ein kostenpflichtiges Makro verwenden. \u201eTabellenfilter\u201c<\/a><\/noindex>.<\/p>\n

In dieses Makro muss eine Tabelle eingef\u00fcgt werden (man kann sogar die h\u00e4sslichste verwenden, Hauptsache, man steckt sie ganz hinein). Im Makro k\u00f6nnen Spalten f\u00fcr den Filter aus einer Dropdown-Liste, einem Textfilter, einem Zahlenfilter und einem Datumsfilter gew\u00e4hlt werden. <\/p>\n

\"Entwurf
\n
\nStellen Sie sich vor, dass alle Informationen \u00fcber Kandidaten f\u00fcr alle Stellen in einer tabellarischen Liste erfasst werden. Nat\u00fcrlich ist diese nicht sortiert \u2013 die Leute kommen ja nicht alphabetisch zu Vorstellungsgespr\u00e4chen. Und Sie m\u00fcssen herausfinden, ob Sie bereits ein Gespr\u00e4ch mit einem bestimmten Bewerber gef\u00fchrt haben. Man muss einfach dieses Chaos in ein Filter-Makro stecken, einen Textfilter nach dem Nachnamen hinzuf\u00fcgen \u2013 und voil\u00e0, die Informationen sind auf dem Bildschirm.<\/p>\n

\"Entwurf
\n
\nEs ist zu beachten, dass die Filterung gro\u00dfer Tabellen die Systemleistung und die Ladezeiten von Seiten beeinflussen kann. Daher ist es nur eine vor\u00fcbergehende L\u00f6sung, eine gro\u00dfe Tabelle in einen Filter zu stecken. Besser w\u00e4re es, einen Prozess zu gestalten, in dem die Menschen 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 jeder Spalte festgelegt und die Zeilen nummeriert werden. Alternativ kann man auf eine beliebige Spalte der Tabelle klicken, die in das Filter-Makro eingef\u00fcgt wurde, und die Sortierung erfolgt nach dieser Spalte. <\/p>\n

\"Entwurf
\n
\nBeispielsweise haben Sie dieselbe Tabelle mit Bewerbern und m\u00f6chten ermitteln, wie viele Vorstellungsgespr\u00e4che in einem bestimmten Monat stattgefunden haben \u2013 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\u00f6nnte man sie in Excel kopieren, die gew\u00fcnschten Berechnungen vornehmen und die Daten zur\u00fcck in Confluence exportieren. Man kann auch einmalig das Makro \u201ePivot-Tabelle\u201c<\/a><\/noindex> anwenden und das gleiche Ergebnis erhalten, nur dass es auch aktualisiert wird.<\/p>\n

Beispielsweise haben Sie eine Tabelle, die alle Mitarbeiterdaten enth\u00e4lt \u2013 wo sie sich geografisch befinden und welche Positionen sie einnehmen. Um zu berechnen, wie viele Personen sich in jeder Stadt befinden, m\u00fcssen Sie im Makro \u201ePivot-Tabelle\u201c die Zeile ausw\u00e4hlen, nach der die Daten aggregiert werden (Standort) und den Operationstyp (Summierung).<\/p>\n

\"Entwurf
\n
\nNat\u00fcrlich k\u00f6nnen mehrere Merkmale gleichzeitig gruppiert werden, s\u00e4mtliche M\u00f6glichkeiten k\u00f6nnen Sie sich ansehen. Dokumentation<\/a><\/noindex>.<\/p>\n

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

\nWie ich schon sagte, lieben nicht alle Tabellen so sehr wie ich. Leider m\u00f6gen die meisten Manager sie \u00fcberhaupt nicht. Aber alle lieben bunte, auff\u00e4llige Diagramme.
\nDie Sch\u00f6pfer von Confluence wussten das nat\u00fcrlich (sie haben sicherlich auch Vorgesetzte, die Berichte und Diagramme lieben, wo k\u00e4men wir da hin). Daher k\u00f6nnen Sie das magische Makro \u201eDiagramm aus Tabelle\u201c<\/a><\/noindex>. In dieses Makro m\u00fcssen Sie die Pivot-Tabelle aus dem vorherigen Punkt einf\u00fcgen, und voila \u2013 Ihre grauen, langweiligen Daten werden ansprechend visualisiert.<\/p>\n

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

Einfachheit der Aggregation<\/h2>\n

\nDie Informationen aus den vorherigen Punkten werden Sie sicherlich nicht \u00fcberrascht haben. Aber jetzt wissen Sie genau, wie man Makros nutzt, und ich kann zu dem interessanteren Teil des Artikels \u00fcbergehen.<\/p>\n

\"Entwurf
\n<\/p>\n

Tags<\/h3>\n

\nEs ist schlecht, wenn Menschen Informationen in einem einzigen unstrukturierten Artikel oder einer riesigen Tabelle speichern. Noch schlimmer ist es, wenn Teile dieser Informationen nicht nur unleserlich formatiert sind, sondern auch \u00fcber Confluence verstreut sind. Zum Gl\u00fcck gibt es die M\u00f6glichkeit, verstreute Informationen an einem Ort zu sammeln. Dazu muss man Tags<\/a><\/noindex> verwenden (bekannt aus den sozialen Medien).<\/p>\n

\"Entwurf
\n
\nMan kann jeder Seite beliebig viele Tags hinzuf\u00fcgen. Wenn Sie auf einen Tag klicken, landen Sie auf einer Aggregationsseite, die Links zu allen Materialien mit diesem Tag sowie zu einer Reihe verwandter Tags enth\u00e4lt. Verwandte Tags sind diejenigen, die h\u00e4ufig auf einer Seite vorkommen.<\/p>\n

\"Entwurf
\n<\/p>\n

Seitenattribute<\/h3>\n

\nF\u00fcr die Strukturierung von Informationen kann man ein weiteres interessantes Makro hinzuf\u00fcgen - \u201eSeitenattribute\u201c<\/a><\/noindex>. In dieses m\u00fcssen Sie eine Tabelle mit zwei Spalten einf\u00fcgen, wobei die erste den Schl\u00fcssel und die zweite den Wert des Attributs darstellt. Dabei kann das Makro auf der Seite verborgen werden, damit es das Lesen des Inhalts nicht st\u00f6rt, aber die Seite wird dennoch mit den ben\u00f6tigten Schl\u00fcsseln gekennzeichnet.<\/p>\n

\"Entwurf
\n
\nAchten Sie auf die ID - es ist praktisch, diese festzulegen, um unterschiedliche Gruppen von Attributen auf verschiedene Seiten (oder sogar unterschiedliche Gruppen von Attributen auf einer Seite) anzuwenden. <\/p>\n

Berichte<\/h3>\n

\nAnhand der Tags k\u00f6nnen Berichte erstellt werden. Zum Beispiel sammelt das Makro \u201eInhaltsbericht\u201c<\/a><\/noindex> alle Seiten mit einem bestimmten Satz von Tags.<\/p>\n

\"Entwurf
\n
\nEin interessanterer Bericht ist jedoch das Makro \u201eSeitenattributbericht\u201c<\/a><\/noindex>. Es sammelt ebenfalls alle Seiten mit einem bestimmten Satz von Tags, zeigt jedoch nicht einfach nur eine Liste an, sondern erstellt eine Tabelle (merken Sie die Verbindung zum ersten Teil des Artikels?), in der die Spalten die Schl\u00fcssel der Seitenattribute sind.<\/p>\n

\"Entwurf
\n
\nSo ergibt sich eine Pivot-Tabelle mit Informationen aus verschiedenen Quellen. Sch\u00f6n ist, dass sie \u00fcber n\u00fctzliche Funktionen verf\u00fcgt: responsive Layout, Sortierung nach beliebiger Spalte. Au\u00dferdem kann diese Berichtstabelle innerhalb des Makros konfiguriert werden. <\/p>\n

\"Entwurf
\n
\nBei der Konfiguration k\u00f6nnen bestimmte Spalten aus dem Bericht entfernt, der Standardzustand oder die Anzahl der angezeigten Eintr\u00e4ge festgelegt werden. Man kann auch die ID des Seitenattributs angeben, um nur die gew\u00fcnschten Informationen anzuzeigen.<\/p>\n

Zum Beispiel haben Sie eine Vielzahl von Mitarbeiterseiten, und diese Seiten haben eine Reihe von Eigenschaften \u00fcber eine Person: welches Niveau sie haben, wo sie sich befinden, wann sie ins Team gekommen sind usw. Diese Eigenschaften sind gekennzeichnet ID = employee_inf<\/i>. Und es gibt eine zweite Reihe von Eigenschaften auf derselben Seite, die Informationen \u00fcber die Person als Teil des Teams sammeln: welche Rolle die Person einnimmt, in welchem Team sie ist usw. Diese Eigenschaften sind gekennzeichnet ID = team_inf<\/i>. Dann k\u00f6nnen Sie beim Erstellen des Berichts Informationen zu einem einzigen ID oder sofort zu beiden \u2013 je nach Bedarf \u2013 abrufen.<\/p>\n

Die Sch\u00f6nheit dieses Ansatzes liegt darin, dass jeder die ben\u00f6tigte Informationstabelle erstellen kann, die nichts dupliziert und sich beim Aktualisieren der Hauptseite aktualisiert. Zum Beispiel: Ein Teamleiter ist nicht interessiert, wann seine Entwickler eingestellt wurden, aber wichtig ist, welche Rolle jeder von ihnen im Team spielt. Der Teamleiter wird sich einen Bericht \u00fcber das Team zusammenstellen. Ein Buchhalter hingegen interessiert sich \u00fcberhaupt nicht daf\u00fcr, wer welche Rolle spielt, aber die Positionen sind wichtig \u2013 er wird sich einen Bericht \u00fcber die Positionen erstellen. Dabei wird die Informationsquelle nicht dupliziert oder verschoben.<\/p>\n

Der finale 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 die neue Information sofort strukturiert sein und in alle bereits verwendeten Aggregationsmechanismen eingef\u00fcgt werden.<\/p>\n

Hier kommt die Kombination aus Makros und Vorlagen ins Spiel. Um die Leute dazu zu bringen, neue Seiten im richtigen Format zu erstellen, kann das Makro \u201eAus Vorlage erstellen\u201c verwendet werden. Es f\u00fcgt der Seite eine Schaltfl\u00e4che hinzu, mit der beim Klicken eine neue Seite aus der gew\u00fcnschten Vorlage erstellt wird. So zwingen Sie die Leute, sofort im gew\u00fcnschten Format zu arbeiten. <\/p>\n

\"Entwurf
\n
\nIn die Vorlage, aus der Sie eine Seite erstellen, sollten im Voraus Tags, das Makro \u201eSeiteigenschaften\u201c und die Tabelle der ben\u00f6tigten Eigenschaften eingef\u00fcgt werden. Ich empfehle au\u00dferdem, Anweisungen hinzuzuf\u00fcgen, welche Werte die Seite haben sollte und welche Eigenschaften sie besitzen sollte.<\/p>\n

\"Entwurf
\n
\nDann wird der finale Prozess folgenderma\u00dfen 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 Eigenschaften der Seite im Makro hinzu.<\/li>\n
  3. An jedem beliebigen Ort erstellen Sie eine Hauptseite mit einer Schaltfl\u00e4che, durch die beim Klick eine untergeordnete Seite aus einer Vorlage erstellt wird. <\/li>\n
  4. Sie lassen Benutzer auf die Hauptseite zu, die potenziell die ben\u00f6tigten Informationen generieren (basierend auf der ben\u00f6tigten Vorlage, indem sie auf die Schaltfl\u00e4che klicken).<\/li>\n
  5. Sie stellen sich einen Bericht \u00fcber die Eigenschaften der Seite mithilfe der von Ihnen in der Vorlage angegebenen Tags zusammen.<\/li>\n
  6. Sie freuen sich: Sie haben alle ben\u00f6tigten Informationen in einem praktischen Format. <\/li>\n<\/ol>\n

    \"Entwurf
    \n<\/p>\n

    Herausforderungen<\/h3>\n

    \nAls Qualit\u00e4tsingenieur kann ich mit \u00dcberzeugung sagen, dass es nichts Perfektes in der Welt gibt. Selbst g\u00f6ttliche Tabellen sind nicht perfekt. Und in dem oben genannten Prozess gibt es einige T\u00fccken.<\/p>\n