👇 🤜🏾 💌 Design bei Confluence 👨🏻‍🎓 ⏺️ ⚙️

Hallo alle zusammen!

Mein Name ist Masha, ich arbeite als Qualitätssicherungsingenieur in der Tinkoff-Unternehmensgruppe. QS-Arbeit beinhaltet viel Kommunikation mit verschiedenen Personen aus verschiedenen Teams, und ich war auch Manager und Dozent für Bildungsprogramme, sodass meine Kommunikationskarte so breit wie möglich war. Und irgendwann explodierte ich: Mir wurde klar, dass ich die Menge unlesbarer Tabellen und Dokumente nicht mehr, nicht mehr füllen konnte.

Sicherlich stellte sich jeder von Ihnen jetzt vor, wovon ich sprach, und schwitzte kalt: Listen mit Nachnamen ohne alphabetische Reihenfolge, Tabellen mit Hunderten von Spalten mit ausgezogenem Layout, Tabellen mit Tausenden von Zeilen, in denen Sie Ihren Finger auf dem Mausrad löschen müssen, um zu sehen Überschrift, Tonnen von Seiten mit nicht nummerierten Anweisungen, Hunderte von Briefen, die mit Daten aneinander gesendet wurden, die analysiert und systematisiert und in dieselben unlesbaren Tabellen gestopft werden müssen.

Als mir etwas kalt wurde, beschloss ich, diesen Artikel zu schreiben. Ich werde darüber sprechen, wie Sie normalerweise (manchmal sogar bequem) eine Vielzahl von Nicht-Produktdokumentationen pflegen können. Ich hoffe, dass sich der Artikel über das Netzwerk verbreitet und der Bekanntheitsgrad in den an die Entwicklung angrenzenden Abteilungen sogar geringfügig abnimmt und die Menschen (einschließlich meiner selbst) ein wenig glücklicher werden.

Werkzeuge

Die Produktdokumentation wird häufig in der Nähe des Codes aufbewahrt, was gut ist. Und Nicht-Produktdokumentationen werden normalerweise überall gespeichert. Oft versuchen Menschen, Informationen von verschiedenen Orten nach Confluence zu übertragen, und wir sind keine Ausnahme. Also die ganze weitere Geschichte über ihn.

Im Allgemeinen ist Confluence eine erweiterte Wiki-Engine. Sie können mit Daten in verschiedenen Anzeigetypen arbeiten: Text mit Formatierung, Tabellen, verschiedene Diagramme. Dies ist ein sehr interessantes und leistungsstarkes Tool. Wenn Sie jedoch nicht wissen, wie man es kocht, erhalten Sie einen weiteren Speicherauszug mit unlesbaren Dokumenten. Ich werde dir das Kochen beibringen!

Makros

Fast die gesamte Confluence-Magie basiert auf Makros. Es gibt viele Makros, die miteinander kombiniert werden können. Sie sind kostenpflichtig und kostenlos, dann gibt es verschiedene Beispiele für Makros mit Links zur Dokumentation für sie.

Die Makroschnittstelle ist so einfach wie möglich. Um ein Makro hinzuzufügen, klicken Sie auf das Pluszeichen und wählen Sie das gewünschte Element aus der Liste aus.

Wenn das Makro autark ist, das heißt, es erfordert nicht das Einfügen von etwas anderem in sich selbst, es sieht aus wie ein Block.

Wenn das Makro funktionieren soll, müssen Sie etwas hineinstecken. Es sieht aus wie ein Rahmen.

In diesem Fall können Sie beliebig viele andere in den Rahmen einfügen, wenn Ihre Pyramide nur logisch ist.

Jedes Makro hat eine Vorschau: Es zeigt sofort an, ob Sie das Makro korrekt fertiggestellt und konfiguriert haben.

Muster

Neben Makros gibt es ein praktisches Tool zum Vorfüllen von Inhalten - dies ist eine Vorlage.
Vorlagen können beim Erstellen einer beliebigen Seite verwendet werden: Klicken Sie einfach auf die drei Punkte neben der Schaltfläche "Erstellen" und wählen Sie die gewünschte Vorlage aus.

Anschließend wird der gesamte Inhalt der Vorlage zur erstellten Seite hinzugefügt.

Jeder kann Seiten aus Vorlagen erstellen, aber nur diejenigen, die das Recht haben, Vorlagen selbst zu erstellen oder zu bearbeiten. Sie können der Vorlage zusätzliche Anweisungen zum Verwalten der Seite hinzufügen.

Tischzauber

Eigentlich liebe ich als Technikfreak Tische sehr und kann fast alle Informationen darin verpacken (obwohl dies nicht immer effektiv ist). Die Tabellen selbst sind klar, strukturiert, skalierbar, magisch!

Aber selbst eine so wunderbare Einheit wie ein Tisch kann ruiniert werden. Und Sie können erfolgreich nutzen und sogar verbessern. Darüber unten.

Filtern (kostenpflichtiges Plugin)

Jede große unlesbare Tabelle kann durch Filtern etwas weniger groß und etwas lesbarer gemacht werden. Dazu können Sie das kostenpflichtige Makro "Filtertabellen" verwenden .

Innerhalb dieses Makros müssen Sie die Tabelle kleben (Sie können sogar die hässlichste, die Hauptsache ist, es ganz zu schieben). Im Makro können Sie die Spalten für den Filter mit einer Dropdown-Liste, einem Textfilter, einem numerischen Filter und einem Filter nach Datum auswählen.

Stellen Sie sich vor, alle Informationen zu den Kandidaten für alle offenen Stellen werden in einer tabellarischen Liste aufgezeichnet. Natürlich unsortiert - Leute kommen nicht alphabetisch zu Interviews. Und Sie müssen verstehen, ob Sie zuvor einen bestimmten Bewerber interviewt haben. Sie müssen nur diese Hölle in das Filtermakro einfügen, einen Textfilter nach Nachnamen hinzufügen - und voila, die Informationen auf Ihrem Bildschirm.

Es ist erwähnenswert, dass das Filtern großer Tabellen das System und die Ladezeit von Seiten beeinflussen kann. Das Einfügen einer großen Tabelle in den Filter ist daher eine vorübergehende Krücke. Es ist besser, einen Prozess zu erstellen, in dem keine großen unlesbaren Tabellen erstellt werden müssen (ein Beispiel für den Prozess finden Sie am Ende des Artikels).

Sortieren (kostenpflichtiges Plugin)

Mit dem magischen Makro „Tabellenfilter“ können Sie auch die Standardsortierung nach einer beliebigen Spalte festlegen und die Zeilen nummerieren. Oder klicken Sie auf eine Spalte der Tabelle, die in das Filtermakro eingefügt wird, und die Sortierung nach dieser Spalte erfolgt.

Sie haben beispielsweise dieselbe Tabelle mit Bewerbern und müssen herausfinden, wie viele Interviews in einem bestimmten Monat durchgeführt wurden - sortieren Sie nach Datum und seien Sie glücklich.

Übersichtstabellen (kostenpflichtiges Plugin)

Kommen wir nun zu dem interessanteren Fall. Stellen Sie sich vor, Ihr Tisch ist riesig und Sie müssen etwas daraus berechnen. Natürlich können Sie es nach Excel kopieren, berechnen, was Sie benötigen, und die Daten wieder in Confluence hochladen. Oder Sie können das Makro „Pivot-Tabelle“ einmal anwenden und das gleiche Ergebnis erhalten, aber auch aktualisiert.

Beispiel: Sie haben eine Tabelle, in der die Daten aller Mitarbeiter erfasst werden - wo sie sich geografisch befinden und welche Positionen sie einnehmen. Um zu berechnen, wie viele Personen sich in jeder Stadt befinden, müssen Sie im Makro „Übersichtstabelle“ eine Zeile auswählen, nach der Daten (Standort) und Art der Operation (Aggregation) aggregiert werden.

Natürlich können Sie nach mehreren Kriterien gleichzeitig gruppieren, alle Funktionen finden Sie in der Dokumentation .

Charts (kostenpflichtiges Plugin)

Wie gesagt, nicht jeder mag Tische so sehr wie ich. Leider mögen die meisten von ihnen Manager überhaupt nicht. Aber jeder liebt lebendige Farbkarten.
Die Macher von Confluence wussten natürlich davon (sie haben wahrscheinlich auch einen Chef, der Berichte und Diagramme liebt, aber wo ohne). Daher können Sie den Zauber Makro verwenden „Chart aus der Tabelle . “ In diesem Makro müssen Sie die Pivot-Tabelle aus dem vorherigen Absatz und voila einfügen - Ihre grauen, langweiligen Daten werden wunderschön visualisiert.

Natürlich hat dieses Makro auch Einstellungen. Ein Link zur Dokumentation für jedes Makro befindet sich im Bearbeitungsmodus dieses Makros.

Einfache Aggregation

Die Informationen in den vorherigen Absätzen waren wahrscheinlich keine Offenbarung für Sie. Aber jetzt wissen Sie definitiv, wie man Makros verwendet, und ich kann zum interessanteren Teil des Artikels übergehen.

Stichworte

Es ist schlecht, wenn Leute Informationen in einem unstrukturierten Artikel oder einer riesigen Tabelle speichern. Noch schlimmer - wenn Teile dieser Informationen nicht nur unlesbar sind, sondern auch über die Weiten von Confluence verstreut sind. Glücklicherweise besteht die Möglichkeit, die verstreuten Informationen an einem Ort zu sammeln. Verwenden Sie dazu die Tags ( Tags , die allen in sozialen Netzwerken bekannt sind).

Sie können jeder Seite eine beliebige Anzahl von Tags hinzufügen. Wenn Sie auf ein Tag klicken, werden Sie zur Aggregationsseite weitergeleitet, auf der Links zu allen Materialien mit diesem Tag sowie zu einer Reihe verwandter Tags vorhanden sind. Verwandte Tags sind solche, die häufig auf derselben Seite gefunden werden.

Seiteneigenschaften

Sie können der Seite ein weiteres interessantes Makro zur Strukturierung von Informationen hinzufügen - " Seiteneigenschaften " . Darin müssen Sie eine Tabelle mit zwei Spalten einreichen, wobei die erste der Schlüssel und die zweite der Wert der Eigenschaft ist. Darüber hinaus kann das Makro auf der Seite ausgeblendet werden, damit das Lesen des Inhalts nicht beeinträchtigt wird. Gleichzeitig wird die Seite jedoch weiterhin mit den erforderlichen Tasten markiert.

Achten Sie auf die ID - es ist praktisch, sie so einzustellen, dass verschiedene Eigenschaftsgruppen auf verschiedenen Seiten (oder sogar verschiedene Eigenschaftsgruppen auf einer Seite) hängen.

Berichte

Mithilfe von Tags können Sie Berichte sammeln. Das Makro " Inhaltsbericht" sammelt beispielsweise alle Seiten mit einem bestimmten Satz von Tags.

Ein interessanterer Bericht ist jedoch das Makro "Seiteneigenschaftenbericht" . Es sammelt auch alle Seiten mit einem bestimmten Satz von Beschriftungen, zeigt jedoch nicht nur eine Liste davon an, sondern erstellt eine Tabelle (Link zum Anfang des Artikels?). In welchen Spalten befinden sich die Schlüssel zu den Seiteneigenschaften.

Es ergibt sich eine zusammenfassende Tabelle mit Informationen aus verschiedenen Quellen. Es ist schön, dass es praktische Funktionen hat: adaptives Layout, Sortieren nach jeder Spalte. Eine solche Berichtstabelle kann auch in einem Makro konfiguriert werden.

Bei der Konfiguration können Sie einige Spalten aus dem Bericht entfernen, den Standardstatus oder die Anzahl der angezeigten Datensätze festlegen. Sie können auch die Seiteneigenschafts-ID festlegen, um nur die benötigten Informationen anzuzeigen.

Sie haben beispielsweise viele Seiten mit Mitarbeitern. Diese Seiten enthalten eine Reihe von Eigenschaften für eine Person: Auf welcher Ebene befindet sie sich, wo befindet sie sich, als sie dem Team beigetreten ist usw. Diese Eigenschaften sind mit ID = employee_inf gekennzeichnet . Auf derselben Seite gibt es eine zweite Reihe von Eigenschaften, die Informationen über die Person als Teil des Teams sammeln: Welche Rolle die Person spielt, in welchem Team sie ist und so weiter. Diese Eigenschaften sind mit ID = team_inf gekennzeichnet . Beim Zusammenstellen des Berichts können Sie dann nur Informationen zu einer oder nur zwei IDs gleichzeitig anzeigen, da dies bequemer ist.

Das Schöne an diesem Ansatz ist, dass jeder die benötigte Informationstabelle sammeln kann, die nichts dupliziert und aktualisiert wird, wenn die Hauptseite aktualisiert wird. Zum Beispiel: Timlidu ist nicht wichtig, wenn seine Entwickler einen Job bekommen, aber es ist wichtig, welche Rolle jeder von ihnen im Team spielt. Timlid wird einen Bericht über das Team sammeln. Und dem Buchhalter ist es egal, wer welche Rolle spielt, aber die Beiträge sind wichtig - er wird einen Bericht über die Beiträge sammeln. In diesem Fall wird die Informationsquelle nicht dupliziert oder übertragen.

Letzter Prozess

Bedienungsanleitung

So können wir Informationen in Confluence am Beispiel von Makros wunderbar strukturieren und effizient aggregieren. Im Idealfall muss jedoch sichergestellt werden, dass die neuen Informationen sofort strukturiert sind und in alle bereits verwendeten Aggregationsmechanismen fallen.

Hier werden eine Reihe von Makros und Vorlagen zur Rettung kommen. Um Benutzer dazu zu bringen, neue Seiten im richtigen Format zu erstellen, können Sie das Makro "Aus Vorlage erstellen" verwenden. Er fügt der Seite eine Schaltfläche hinzu, indem er darauf klickt, welche neue Seite aus der gewünschten Vorlage erstellt wird. So lassen Sie die Leute sofort in dem Format arbeiten, das Sie benötigen.

In der Vorlage, aus der Sie eine Seite erstellen, müssen Sie Beschriftungen, das Makro „Seiteneigenschaften“ und eine Tabelle mit den Eigenschaften hinzufügen, die Sie im Voraus benötigen. Ich empfehle außerdem, Anweisungen hinzuzufügen, welche Werte die Seite füllen sollen, und Eigenschaftswerte.

Dann sieht der letzte Prozess folgendermaßen aus:

Sie erstellen eine Vorlage für Informationen eines bestimmten Typs.
Fügen Sie dieser Vorlage Tags und Seiteneigenschaften im Makro hinzu.
Erstellen Sie an einer beliebigen Stelle eine Stammseite mit einer Schaltfläche, indem Sie darauf klicken, welche untergeordnete Seite aus der Vorlage erstellt wird.
Starten Sie auf der Stammseite von Benutzern, die möglicherweise die erforderlichen Informationen generieren (gemäß der gewünschten Vorlage, indem Sie auf die Schaltfläche klicken).
Erstellen Sie einen Bericht über die Eigenschaften der Seite über die in der Vorlage angegebenen Beschriftungen.
Freuen Sie sich: Sie haben alle notwendigen Informationen in einem praktischen Format.

Unterwasserfelsen

Als Qualitätsingenieur kann ich mit Sicherheit sagen, dass es auf der Welt nichts Ideales gibt. Sogar göttliche Tische sind unvollkommen. Und im obigen Prozess gibt es Fallstricke.

Wenn Sie den Namen oder die Zusammensetzung der Seiteneigenschaften ändern möchten, müssen Sie alle bereits erstellten Objekte aktualisieren, damit ihre Daten korrekt in den Zusammenfassungsbericht übernommen werden. Das ist traurig, aber andererseits lässt es Sie die „Architektur“ Ihrer Informationen im Detail durchdenken, was eine sehr interessante Aufgabe ist.
Sie müssen eine anständige Menge an Anweisungen schreiben, wie Sie Informationstabellen ausfüllen und Tags verwenden. Auf der anderen Seite können Sie in diesem Artikel einfach die richtigen Leute werfen.

Ein Beispiel für das Speichern von Nicht-Produktdokumentationen

Durch den oben beschriebenen Prozess können Sie die Speicherung fast aller Informationen organisieren. Das Schöne an diesem Ansatz ist, dass er universell ist: Wenn Benutzer sich daran gewöhnen, hören sie auf, ein Durcheinander zu erzeugen. Ein großes (aber nicht kostenloses) Plus ist auch die Möglichkeit, verschiedene Statistiken im laufenden Betrieb zu sammeln und schöne Diagramme darauf zu zeichnen.

Ich werde ein Beispiel für unseren Prozess der Pflege von Informationen über das Team geben.

Für jede Person im Team haben wir beschlossen, eine Mitarbeiterkarte zu erstellen. Dementsprechend haben wir eine Vorlage, nach der jede neue Person diese Karte für sich selbst erstellt und alle darin enthaltenen persönlichen Informationen verwaltet.

Wie Sie sehen können, haben wir eine detaillierte Tabelle mit Eigenschaften und sofort Anweisungen zur Pflege dieser Seite. Einige der Tags werden von den Mitarbeitern selbst gemäß den Anweisungen abgelegt, in der Vorlage nur die wichtigsten: Karten-TagMitarbeiterkarte , Richtungs-Tag- Richtung und Team-Qa- Tag .

Nachdem jeder eine Karte für sich selbst erstellt hat, wird eine vollständige Tabelle mit Informationen zu den Mitarbeitern erstellt. Diese Informationen können an verschiedenen Stellen verwendet werden. Ressourcenmanager können allgemeine Tabellen für sich selbst sammeln, und Teamleiter können Teamtabellen erstellen, indem sie der Auswahl ein Team-Tag hinzufügen.

Sie können verschiedene Zusammenfassungen nach Tags anzeigen , z. B. nach QA-Upgrade-Plan. Alle Aufgaben für die QS-Entwicklung werden angezeigt. Gleichzeitig führt jede Person auf ihrer Mitarbeiterkarte eine wichtige Geschichte und ihren Entwicklungsplan - erstellt eine eingebettete Seite aus der Vorlage für Entwicklungspläne.

Fazit

Bewahren Sie alle Unterlagen so auf, dass sie nicht peinlich sind und die Benutzer nicht unerträglich verletzt werden!

Ich hoffe wirklich, dass der Artikel nützlich sein wird und dass alle Dokumentationen der Welt in Ordnung sind.

Design bei Confluence