Wir suchten nach einem Ersatz für MS Word und führten stattdessen einen neuen Dokumentenverwaltungsprozess ein

MS Word wirft regelmäßig „Überraschungen“ auf: Screenshots „ausgezogen“, „schwebende“ Tabellen, leere Seiten beim Drucken. In diesem Artikel geht es darum, wie wir nach einem Ersatz für MS Word gesucht haben (wir haben keinen Spoiler gefunden), aber eine Gelegenheit gefunden, unseren Prozess der weltweiten Arbeit mit Dokumentation zu verbessern.



Bei Uniscan Research machen wir Hightech-Produkte zu einem Serienprodukt. Das Unternehmen ist in den Bereichen B2G (Business-to-Government) und B2C (Business-to-Client) tätig.

Unsere Abteilung entwickelt Design- und Benutzerdokumentation für zu entwickelnde Produkte, Zertifizierungsdokumente, Marketingmaterialien, Bürodesign und Dekoration (Navigation, Türschilder).

Bei Dokumenten im B2C-Bereich können Format, Name und Inhalt der Dokumentation frei gewählt werden. Im B2G-Bereich sollten etwa 70% der von uns entwickelten Dokumentation gemäß den Anforderungen der ESKD erstellt und dem Kunden im DOCX-Format zur Genehmigung vorgelegt werden.

Wir übermitteln dem Benutzer die gesamte Betriebsdokumentation in gedruckter Form, sodass alle Dokumente einer Druckvorstufe unterzogen werden. Unsere Dokumente haben zwei Zielformate: DOCX und PDF.

Für die Umsetzung unserer Aufgaben verwendet die Abteilung seit vielen Jahren traditionell MS Word.

Bei jeder neuen Bearbeitung eines in MS Word kompilierten Dokuments werden in etwa der Hälfte der Fälle Screenshots „herausgeschoben“, Tabellen mit Symbolen „schweben“ und beim Drucken eines Dokuments werden unsichtbare leere Seiten vollständig angezeigt. Diese Dokumentlayoutoperationen nehmen dem Autor des Dokuments nicht nur Zeit, sondern auch den Wunsch nach Kreativität - die Entwicklung neuer Dokumente.

Bei der nächsten Suche nach unsichtbaren leeren Seiten in einem DOCX-Dokument in unserer Abteilung kam die Idee auf, ein neues Tool zur Dokumentationsentwicklung auszuprobieren. Wir wollten die Zeit für das Layout und die Vorbereitung des Dokuments in der Druckvorstufe reduzieren.

Infolgedessen konnten wir MS Word nicht vollständig verwenden, aber im Suchprozess haben wir ein neues Schema für die Arbeit mit der Dokumentation erstellt.

Als nächstes werde ich versuchen, Ihnen zu sagen, welche Tools für die Arbeit mit Dokumenten wir in Betracht gezogen haben, warum wir uns als Ergebnis für Confluence entschieden haben, auf welche Probleme wir gestoßen sind und wie wir sie lösen konnten.

Werkzeugauswahl

Wir lesen Artikel zum Thema vorhandene Tools zur Dokumentationsentwicklung und sprechen mit Kollegen anderer Unternehmen. Die folgenden Tools schienen uns am besten geeignet zu sein:

• Dita
• DocBook XML
• Zusammenfluss

Die ersten beiden Tools passten nicht aus demselben Grund: Wir brauchten Programmierkenntnisse, die wir nicht hatten, und um eine neue Dokumentvorlage zu erstellen, mussten wir einen Programmierer um Hilfe bitten. Der Übergang zur Zusammenarbeit mit ihnen würde nach unseren Vorstellungen etwa sechs Monate dauern, möglicherweise länger. Aufgrund der oben genannten Nachteile haben wir beschlossen, das vollständige Testen dieser Tools abzubrechen.

Confluence von Anfang an erfreute WYSIWYG- Editor. Im Durchschnitt brauchten technische Redakteure etwa eine Woche, um das Tool zu beherrschen, und das Layout von Dokumenten „nicht in Übereinstimmung mit GOST“ war einfacher.

In B2G-Projekten ist PDF für uns als Format für die Benutzerdokumentation wichtig. Daher haben wir sofort das entsprechende Plug-In für Confluence - Scroll PDF Exporter installiert. Damit haben wir versucht, benutzerdefinierte Vorlagen mit den erforderlichen Parametern zu erstellen. Wir waren mit den Testergebnissen zufrieden: Wir haben ungefähr eine Woche lang eines der Dokumente mit einer großen Anzahl von Screenshots und grafischen Elementen in MS Word erstellt. In Confluence ist es uns gelungen, dasselbe Dokument in zwei Tagen zu erstellen und eine bessere visuelle Darstellung zu erzielen.

Wir haben auch versucht, die Vorlage für Scroll Word Exporter so zu konfigurieren, dass ein Dokument gemäß allen ESKD-Regeln ausgestellt wird. Nachdem wir zwei Tage lang die Confluence and Scroll PDF Exporter-Handbücher gelesen und versucht hatten, die aktuelle Vorlage für technische Spezifikationen anzupassen, stellten wir fest, dass dieses Tool nicht für die Entwicklung von Dokumenten geeignet ist, die gemäß den Anforderungen von ESKD ausgeführt wurden.

So konnten wir beispielsweise keine nummerierten, nicht fettenden Überschriften der zweiten Ebene erstellen, sodass der Text keine Überschrift, sondern ein Absatz war. Ich musste die Absatznummer manuell schreiben und den Absatzstil verwenden. Es war unmöglich, Listen mit Aufzählungszeichen mit einem Bindestrich (nur Kreise, Quadrate) anzuordnen, nummerierte Listen wurden ohne Punkt gezeichnet und Buchstabenlisten wurden nur mit lateinischen Buchstaben erstellt. Die Einrückung wurde nur manuell angepasst.

Einige Monate, nachdem wir begonnen hatten, Confluence zu beherrschen, implementierten die Entwickler des Tools die Funktion zum Bearbeiten von Dokumenten in ihrem ursprünglichen Format. Dies ermöglichte es uns, unsere "Gast" -Dokumente zu speichern und neue Dokumente zu erstellen, die keine strikte Ausführung am selben Ort erfordern. MS Word-Dateien werden in Confluence als Anhänge gespeichert. Wenn sie bearbeitet werden, werden sie geöffnet und in MS Word auf dem PC des Benutzers gespeichert. Beim Speichern wird die neue Version automatisch in Confluence hochgeladen.

So kamen wir auf die Idee, Confluence als Werkzeug zu verwenden, das gleichzeitig drei Probleme lösen würde:

1. Erstellen einer Wissensbasis.
2. Entwicklung, Speicherung und Aktualisierung von Dokumentationen, die nicht nach GOST entwickelt wurden.
3. Speicherung und Aktualisierung der gemäß GOST entwickelten Dokumentation.

Möglicher Zusammenfluss

Unsere Erwartungen an die Confluence-Funktionalität wurden nicht vollständig erfüllt, aber nach Abschluss der Tests bildete sich eine allgemein positive Einstellung zu diesem Tool. Nachfolgend haben wir die wichtigsten Vorteile für unsere Abteilung formuliert:

1. Passen Sie das Tool selbst an und unterstützen Sie es.
2. Leicht zu lernen.
3. Die Möglichkeit, eine Wissensdatenbank über die Produkte des Unternehmens zu organisieren und alle kompilierten Dokumentationen in DOCX und PDF an einem Ort zu speichern.
4. Unterstützung für versionierte Dokumente.
5. Möglichkeit zur Verwendung von Single-Source-Technologie.
6. Die Möglichkeit der gemeinsamen Arbeit von Entwicklern und technischen Redakteuren an Dokumenten.
7. Speicherung von Arbeitsdokumenten und Informationen an einem Ort.
8. Die Möglichkeit, Dokumente jederzeit und von jedem Ort der Welt aus zu entwickeln.

Implementierung

Um Confluence zu implementieren, haben wir zwei Spezialisten aus der Abteilung für technische Redakteure ausgewählt, die die Funktionen des Tools untersucht und getestet haben.
Für die kontinuierliche technische Unterstützung hat uns die Abteilung Systemadministratoren einen Spezialisten zugewiesen. Er reagierte schnell auf technische Probleme und half, die Grundeinstellungen des neuen Tools zu verstehen.

Gleichzeitig haben wir eine Arbeitsgruppe in der Abteilung für technische Redakteure eingerichtet, deren Aufgabe es war, die Datenspeicherstruktur zu planen. Die gesamte Struktur unseres Servers wurde in Kategorien unterteilt, die den Projekttypen des Unternehmens entsprechen. Die Kategorien wurden wiederum nach Unternehmensprodukten in Räume unterteilt. Wir haben auch eine separate Kategorie für die interne Wissensbasis identifiziert.

Als die für das Testen der Systeme Verantwortlichen die Arbeit in Confluence ziemlich gründlich studierten, begann die Phase des Peer-to-Peer-Trainings. Es dauerte ungefähr einen Monat, um Wissen an die gesamte Abteilung zu übertragen.

Technische Probleme

Die Implementierung von Confluence verlief insgesamt recht reibungslos, es gab jedoch Probleme.

Layout und Vorbereitung der Dokumente in der Druckvorstufe

„Ich habe es in wenigen Sekunden in MS Word gemacht. Wie mache ich dasselbe in Confluence? “ - Wir haben uns während des gesamten Testzeitraums jeden Tag eine solche Frage gestellt.

Es war also überhaupt nicht offensichtlich, wie der Inhalt der Tabelle vertikal ausgerichtet oder eine Symbolgröße von weniger als 16 Pixel zugewiesen werden sollte.

In der Tat sind die grundlegenden Funktionen zur Seitenformatierung im Confluence WYSIWYG-Editor viel schlechter als in MS Word. Die Funktionalität kann jedoch erheblich erweitert werden, wenn Sie in den Quellcode-Bearbeitungsmodus wechseln und direkt mit HTML-Code arbeiten.

Wir haben Artikel gelesen, Schulungsvideos zum HTML-Layout angesehen und die gefundenen Lösungen geteilt. Wir haben in Confluence eine separate Seite erstellt, auf der wir nützliche Informationen zur Arbeit mit diesem Tool platziert haben.

Confluence und Plugin Update

Nach dem ersten Update des Haupt-Plugins für Scroll PDF Exporter flogen 80% der Makros ab und die Seitenstruktur ging zu Confluence über. Später stellte sich heraus, was aufgrund der neuen Funktionalität des Plugins passiert ist. In der gesamten Abteilung haben wir die Struktur der Dokumente für mehrere Tage wiederhergestellt. Danach haben wir einen Plan für die Aktualisierung für die Zukunft erstellt, an den wir uns noch halten:

1. Führen Sie das Update am Freitag durch, wenn die Hauptarbeitsschicht der Woche abgeschlossen ist, um mögliche Probleme am Wochenende beseitigen zu können.
2. Verteilen Sie es an alle Benutzer des Systems, um sie über den Zeitpunkt des geplanten Updates zu informieren.
3. Sichern Sie vor dem Upgrade den Server.
4. Aktualisieren Sie die Version von Confluence.
5. Testen Sie den Server, stellen Sie sicher, dass alle Informationen vorhanden sind und Links zu externen und internen Ressourcen funktionieren.
6. Wenn Sie die Plugins aktualisieren müssen, sichern Sie den Server erneut.
7. Aktualisieren Sie Ihre Plugins jeweils einzeln.
8. Testen Sie das Plugin sofort nach dem Upgrade.

Massenbenachrichtigungen

Als die turbulenten Aktivitäten von technischen Redakteuren und Entwicklern in Confluence endlich zu kochen begannen, erhielt der Administrator Anrufe von Benutzern des Dienstes. Sie baten darum, sie vor einem Massenangriff durch E-Mail-Benachrichtigungen über die Aktionen anderer Benutzer zu schützen.

Standardmäßig musste der Benutzer nur einmal zu einer Seite gehen. Danach wurde er vom System automatisch zur Liste der Beobachter hinzugefügt und erhielt bei jeder Änderung dieser Seite Benachrichtigungen.

Darüber hinaus hat Confluence freundlicherweise wöchentliche Newsletter an Benutzer verschickt, in denen die beliebtesten Confluence-Seiten aufgelistet sind. Glücklicherweise wurde dieses Problem im Internet bereits umfassend behandelt. Die Lösung besteht darin, die entsprechenden Benachrichtigungen in den Systemeinstellungen zu deaktivieren:


Jetzt erhalten Benutzer nur dann Benachrichtigungen, wenn ihr Name in den Kommentaren zum Artikel erwähnt wird.

Serverstabilität

Um Confluence zu testen, haben wir einen Windows-Server bereitgestellt. In der Anfangsphase stürzte der Server häufig ab. Ein Teil des Problems stellte sich als unzureichender Arbeitsspeicher auf dem Server heraus (empfohlene Größe ist 11-12 GB). Die verbleibenden Probleme waren behoben, als wir die in solchen Fällen empfohlenen Systemeinstellungen aktivierten.

Jetzt arbeitet der Server ziemlich stabil - Störungen treten ungefähr 1 Mal in 2 Monaten auf. Im Falle eines Fehlers reicht ein Neustart aus, um ihn zu reparieren.

Dokumentenmanagement im Zusammenfluss

Heute arbeiten technische Redakteure, Programmierer, Elektronikingenieure und Qualitätssicherer in Confluence zusammen.

Wir wollten MS Word komplett aufgeben, Dokumente ausschließlich in Confluence entwickeln und in DOCX und PDF konvertieren. In der Realität stellte sich heraus, dass Sie auf den langwierigen Prozess verzichten müssen, alle vorhandenen Dokumentationen in ein neues Format zu übertragen und dann Vorlagen in Scroll PDF / Word Exporter einzurichten. Nach unseren Schätzungen würden wir dafür etwa sechs Monate brauchen. Es stellte sich als viel einfacher heraus, alle entwickelten Dokumente im MS Word-Format in Confluence zu übertragen und dort zu verwalten.

Wir haben uns entschlossen, von Confluence keine wunderbare Formatierung gemäß allen Anforderungen von ESKD zu erwarten, und alle Benutzerdokumente einfach bedingt in Dokumente für den „Staatskunden“ und Dokumente für den „Nicht-Staatskunden“ unterteilt.

Die ersten erstellen wir im DOCX-Format, speichern und aktualisieren sie in Confluence. Letzteres entwickeln wir direkt in Confluence, exportieren es bei Bedarf als PDF.

Dank der integrierten Makros verwenden wir in der Benutzerdokumentation die Single-Source-Technologie. Jetzt müssen wir nicht mehr einen Parameter in mehreren Dokumentversionen manuell ändern.

Der praktische WYSIWYG-Editor erleichtert das Vornehmen von Änderungen am fertigen Dokument - Screenshots, Symbole und grafische Elemente bleiben erhalten.


Mit der Funktion zur gemeinsamen Bearbeitung können Sie an einem Dokument zusammenarbeiten. Sie können das Dokument direkt in Confluence mit einem technischen Experten teilen und seine Kommentare in Echtzeit diskutieren, anstatt das Dokument endlos per E-Mail zu verbreiten.

Um außerhalb des Büros zu arbeiten, müssen Sie den Remotezugriff nicht konfigurieren. Um von zu Hause aus arbeiten zu können, benötigen Sie nur das Internet.

Confluence bietet dem Benutzer die vertraute Webseitenoberfläche mit der Möglichkeit, Querverbindungen zu konfigurieren und mehrere Registerkarten im Browser gleichzeitig für die Arbeit zu öffnen.

Jetzt speichern wir alle Dokumente, grafischen Elemente und Fotos von Geräten und unterhalten an einem Ort eine Wissensbasis über Unternehmensprodukte. Sie müssen nicht darüber nachdenken, wo sich die Quelle der Bilder oder die neueste Version der Dokumente befinden kann.

Was möchten Sie sonst noch tun?

Derzeit richten wir den Confluence-Seitenausrichtungsprozess mithilfe des Comala Workflow-Plugins ein. Dieses Plugin funktioniert jedoch nicht mit MS Word-Anhängen. Wir koordinieren solche Dokumente mit Hilfe von Versionskommentaren. Jetzt erwägen wir Optionen zum Festlegen der automatischen Genehmigung von DOCX-Anhängen. Ich möchte, dass der Genehmigungs- und Genehmigungsprozess gleichzeitig mit Confluence-Seiten und Anhängen im DOCX-Format verwendet wird.

Wenn wir die automatische Genehmigung von Anhängen einrichten, werden wir versuchen, eine schnelle Konvertierung von MS Word in PDF durchzuführen. Und dann - Dokumente an unseren Druckproduktserver senden, von wo aus die Druckerei die Dokumente zum Drucken bringt.

Plötzliche Anweisungen finden

Wir haben es nie geschafft, MS Word aufzugeben, aber als wir einen Ersatz fanden, fanden wir plötzlich etwas mehr. Confluence brachte Entwickler aus verschiedenen Abteilungen zusammen, bildete die Wissensbasis des Unternehmens und wurde zum Aufbewahrungsort aller Unternehmensdokumente, unabhängig von ihrem Format.

Unser Unternehmen hat ein Prinzip: Treffen Sie in jeder unverständlichen Situation systematisch Entscheidungen. Wir glauben, dass eine Lösung, die auf einem Modell beruht, besser ist als eine, die auf Expertenmeinung oder Intuition basiert.

Im Fall von Confluence hat sich das Modell von Eric Rhys von The Lean Startup als nützlich erwiesen. In der Produktentwicklung hilft es, die Richtung der Produktentwicklung zu ändern. Probieren Sie bei der Suche nach einem Ersatz für MS Word ein neues Tool aus und finden Sie die entsprechenden Vorteile.

Wir wünschen anderen technischen Redakteuren nützliche Modelle!