Jetzt ein Schuhmacher mit Stiefeln oder wie wir unseren eigenen Styleguide bekommen haben

Ich gehe davon aus, dass Sie sich, liebe Leser, in Ihrer Arbeit mit technischer Dokumentation und möglicherweise sogar mit denen, die sie erstellen, befassen mussten - mit technischen Redakteuren. Und auf unserem Blog können Sie einen technischen Redakteur aus dem Veeam-Team treffen.

Heute gehen wir zur nächsten Ebene des Verständnisses über, wie die Entwicklung der technischen Dokumentation in Veeam Software funktioniert.

KDPV täuscht - das ist kein Wunder, sondern die gleiche Arbeit wie alle anderen F & E-Kollegen. Diejenigen, die Anleitungen erstellen, haben jedoch magische Wörter für ihre Anleitungen zum Erstellen von Anleitungen! Hier ist eine solche Rekursion.

Lesen Sie mehr in der Geschichte meiner Kollegin Daria Shalygin.

Hallo, mein Name ist Dasha und ich bin Content Quality Lead bei Veeam Software. Ich bin verantwortlich für die Qualität der Inhalte, die von der Abteilung für technische Redakteure unseres Unternehmens erstellt wurden. In der Praxis bin ich technischer Redakteur und Redakteur in einer Flasche. Meine Aufgaben umfassen:

• Ich leite meine eigenen Projekte - wie alle technischen Redakteure habe ich meinen Verantwortungsbereich, dh eine Reihe von Produkten, für die ich Dokumentation erstelle und pflege;
• Schulung der Mitarbeiter auf Junior-Ebene - Ich habe einen Einführungskurs für Anfänger erstellt, in dem ich die Grundregeln für das Schreiben von Dokumentationen erläutere.
• Beratung von Mitarbeitern auf höheren Ebenen (erfahrene und leitende Angestellte) - Ich habe tägliche Sitzungen geplant, in denen jedes Mitglied unseres Teams mir Fragen zur Dokumentation stellen kann (ob es sich um Wortlaut, Struktur usw. handelt).
• — , , , .

Noch vor 3 Jahren hatten wir nur 8 technische Redakteure. Als jemand Neues kam, studierte er die vorhandenen Leitfäden und begann ungefähr auf die gleiche Weise zu schreiben. Es war eine wundervolle Zeit, in der wir alle ungefähr das gleiche Gefühl von Schönheit hatten und mühelos zu einem gemeinsamen Verständnis kommen konnten, wie man Dokumentation für unsere Produkte schreibt.

Die Zeit verging, das Unternehmen wuchs, es gab mehr Produkte und es bestand die Notwendigkeit, das Personal der technischen Redakteure zu erhöhen. Heute sind wir bereits 18 Personen und wir planen nicht, dort anzuhalten. Alles wäre in Ordnung, aber plötzlich stellte sich heraus, dass es bei so vielen Menschen schwierig wird, sich auf das Schöne zu einigen. Es braucht Zeit, Zeit und wieder Zeit.

Um die Energiekosten für den Wissenstransfer an Neuankömmlinge zu senken und ein für alle Mal zu beheben, was in der technischen Dokumentation von Veeam „schön“ ist, wurde beschlossen, einen eigenen Styleguide zu erstellen. Ich muss sagen, dass einige Skizzen zum Thema Stil bereits seit vielen Jahren in Form von Artikeln über Konfluenz und Randnotizen in Notizbüchern existieren, aber all dies war ungeordnet, fragmentiert und natürlich, um über die Benutzerfreundlichkeit und Relevanz der Informationen zu sprechen musste nicht.

Es war:



Als wir unseren Styleguide erstellt haben, haben wir 3 große Guides zugrunde gelegt, die normalerweise als Beispiel für das Schreiben von Dokumentationen dienen: ( Chicago Manual of Style , Microsoft Manual of Style und DITA Best Practices), studierte eine Reihe von Styleguides von Drittanbietern, die mit anderen Unternehmen existieren (z. B. IBM Style Guide , Documentation Style Guide für OpenSolaris und andere), führte eine Studie über die neuesten Trends im Bereich der Dokumentation durch - und mischte dies mit unserer eigenen elfjährigen Erfahrung in Veeam Software. Infolgedessen

wurde:



Der Veeam Technical Writing Style Guide enthielt aktuelle Themen wie die Strukturierung von Inhalten nach Thementyp, einfache englische Prinzipien, Interpunktion, Artikel, Formatierung, Erstellung von Screenshots und Diagrammen, Erstellung von Links zu Ihrer eigenen Dokumentation und Dokumentation von Drittanbietern sowie nützliche Erinnerungen für täglich.

Mit dem Aufkommen des Styleguides haben wir nicht nur den Wissenstransfer an neue Mitarbeiter erleichtert, sondern auch folgende Vorteile erhalten:

• Verhinderung der Notwendigkeit, in Reptilien von Drittanbietern und im Internet nach Antworten auf Fragen zu suchen, die regelmäßig auftreten;
• sofortige Lösung kontroverser Fragen in Bezug auf Sprache, Design und Struktur von Dokumenten;
• bequeme Navigation durch Ihre eigene Wissensbasis;
• die Möglichkeit, Kollegen aus anderen Abteilungen, die direkt oder indirekt mit dem Schreiben von Texten arbeiten (ob Support oder Qualitätssicherung), Links zu bestimmten Abschnitten bereitzustellen.

Bekanntes Meme darüber, wie sich der Schreibstil nach Ihrer Arbeit als technischer Redakteur dramatisch ändert.

Unser Styleguide wurde von Nicht-Muttersprachlern (Nicht-Muttersprachlern) erstellt und war für Nicht-Muttersprachler gedacht. Trotzdem wurde es von unseren Muttersprachlern gelesen und verifiziert, Marketing-Linguisten, die über die entsprechende Ausbildung verfügen, lange Texte für die Website des Unternehmens geschrieben und einen eigenen Styleguide entwickelt haben, der ebenfalls auf den Prinzipien der genannten Giganten basiert Industrie.

Wir arbeiten derzeit an der Erweiterung unserer Wissensbasis. Wir möchten separate Stilrichtlinien für Referenzdokumente wie die REST-API-Referenz und die PowerShell-Referenz erstellen. Für solche Dokumente muss der Inhalt auf besondere Weise strukturiert und korrigiert werden, um die Einheitlichkeit zwischen den Produkten zu gewährleisten.

Wir freuen uns , wenn unsere Style - Guide für andere Unternehmen nützlich sein werden , die nach wie vor nur auf der Suche nach ihrem eigenen Stil. Ich rate Ihnen, sich den Abschnitt mit Hintergrundinformationen anzusehen , die unserer Erfahrung nach bei der Arbeit häufig benötigt werden - es gibt viele interessante Dinge. :)

Veeam Technical Writing Style Guide (Englisch)