Fachvortrag auf der tekom-Frühjahrstagung24. April 2015, Darmstadt !

Martin Häberle, K15t Software GmbH

#tekomf15 FV08

DocOps Agile Dokumentationserstellung in der Praxis

Developer Docs

Getrennte Informationssilos, inhaltliche Überschneidungen

Ausgangssituation

Support KB Docs

Konkurrierende Inhalte, hilflose Kunden

DocOps

Inhalte gemeinsam entwickeln, zentral bereitstellen

DocOps-Ansatz

?Der Name “DocOps”

Der Name “DocOps”

Doc Ops?

Der Name “DocOps”

Do Cops?

abgeleitet von DevOps

Der Name “DocOps”

Developers Operations

Ein kollaborativer Ansatz für Entwicklung + Betrieb in der IT um Software schneller und in besserer Qualität bereitzustellen

+DevOps =

DocOps ist keine Methode, Schreibtechnik, Technologie oder Marke, sondern eine Denkhaltung.

DocOps = DevOps für Inhalte

DocOps

Prozesse

Das DocOps-Erfolgsrezept

Menschen

TechnologieKultur

Kulturelle Faktoren

Teamwork

Team ≠ “Toll, ein anderer

macht’s”

Hüte abgeben

Verantwortung gemeinsam übernehmen

Abschmecken

Messen und bei Bedarf

gegensteuern

Prozessbezogene Faktoren

Retrospektive

Ein Blick zurück hilft beim Blick

nach vorne

Wissensmanagement

Wissenstransfer ist fester Bestandteil jedes Prozesses.

Agiles Vorgehen

Klein anfangen, dann kontinuierlich

verbessern

Kaum Zusammenarbeit

Einverständnis fehlt, dass jeder Inhalte

verbessern darf/soll

Faktor Mensch

Zu wenig Einsicht

Fehlendes Verständnis für die Arbeit

sämtlicher Beteiligten

Starre Hierarchien

Unflexible Linien-Organisation statt interdisziplinärer Teams

Technologische Faktoren

Technologie und Werkzeuge stehen bei DocOps nicht im Vordergrund.

Technologische Faktoren

Kollaboration

Funktionen für Zusammenarbeit, zum Review etc.

Zentralisierung

Informationen sind für alle zentral

zugänglich.

Automatisierung

z.B. Continuous Delivery – auch für technische Inhalte

Auswirkungen

Auswirkungen von DocOps

Kommunikativer

Abstimmung zwischen den

Beteiligten wird ritualisiert.

Sichtbarer

Informations-Erstellung rückt in den Fokus der

Beteiligten.

Qualitätsbewusster

Mehr Feedback und Transparenz

reduziert die Fehlerzahl.

Auswirkungen auf die Technischen Inhalte

Vollständiger

Jeder kann Inhalte erweitern oder

Änderungen anregen.

Aktueller

Jeder kann veraltete Inhalte aktualisieren

und neue Sachverhalte sofort ergänzen.

Nützlicher

Jeder kann seinen Blickwinkel und sein

Expertenwissen einbringen

Kunden-Feedback einarbeiten

Inhalte kuratieren= sammeln + veredeln

Content Strategy (weiter-)entwickeln

Autoren unterstützen und beraten/schulen

Content-Plattform und Prozesse verbessern

DocOps

Auswirkungen auf die Rolle des Techn. Redakteurs

Anwendungsbeispiele

Computer Associates International, Inc. – ein IT-Konzern aus den USA als Beispiel für DocOps in Großunternehmen

300 Beteiligte

Support Knowledge Base und Produktdokumentation wurdenparallel mit hohem Aufwand, aber ohne Synergieeffekte gepflegt.

24.000 Dokumente

Informationsmanagement bei CA

19 Sprachen

Verbesserte Zusammenarbeit gemäß DocOps

Ziele von CA

Schneller Inhalte bereitstellen durch agile Prozesse

Qualität und Nutzwert der technischen Inhalte erhöhen

Zentrale Plattform für alle technischen Inhalte

Übersetzungsprozess

Die Wahl fiel auf die Kollaborationsplattform Atlassian Confluence ergänzt durch die Scroll Add-ons.

AnalyticsSprachprüfungWeb-Zugriff

DocOps-Plattform bei CA

https://wiki.ca.com

Quelle: https://wiki.ca.com/

DocOps-Plattform

Kunde

Automatisiertes Lektorat

Content-Management-Funktionen

Collaborative Authoring & Content Aggregator

Acrolinx Unterstützt Autoren, den CA-Sprachstandard einzuhalten

K15t Software Versionskontrolle via Scroll Versions,

Export, Acrolinx-Anbindung

Lingotek Übersetzungs-Workflow

Atlassian Unternehmensweite Erstellung und Bereitstellung von Inhalten

Autoren können Regelverstöße direkt

korrigieren.

How CA Technologies Broke the RulesThe DocOps Approach to Agile Technical Content

https://youtu.be/2tMsmnZ7HWA

Mehr zu DocOps bei CA Technologies

Agile Software-Entwicklung mit häufigen Releases. Kunden-Support und Technische Redaktion sind nicht getrennt.

DocOps @ K15tSupport-Prozess und Inhalteerstellung kombiniert

Kunde

1. Anfrage/Problem/Change Request geht ein

Anfrage / Change Request

erstellt

Support

wird geprüft von

in Zendesk oder JIRA

Individualproblemin Zendesk

produktrelevantin JIRA

Support + Entwickler

2. Klärung der Anfrage

Individualproblem

wird gelöst von

Kundeinformiert

produktrelevant

KB-Artikelin Confluence

erstellen

Link an Kunden senden / Anfrage abschließen

3. Wissensmanagement in der Knowledge Base

KB-Artikelin ConfluenceSupport + Entwickler

Inhalte werden kontinuierlich verbessert

Tech Writer

sichtet und prüft

4. Relevanz und Priorität für Produktdokumentation klären

KB-Artikelin Confluence

Tech Writerfalls relevant für Iteration einplanen

Doku-Aufgabein JIRA

Support

5. Produktdokumentation erstellen/publizieren

Tech Writer

Doku-Aufgabenin JIRA

KB-Artikelin Confluence

Hilfeinhaltein neuester Version

veröffentlicht

Support

erstellt/ergänzt Inhaltein Confluence

besprechen

Aufgabenin JIRA

Hilfe + KBin Confluence

Produktneueste Version

Prozesseim Unternehmen

bewerten

6. Retrospektive zum Release

Tech WriterSupportEntwickler Product Owner

Verbesserungsmaßnahmenals Aufgabe / Change Request in JIRA

Lessons Learned

Erfolgsfaktoren für DocOps

Chefetage einbindenDocOps funktioniert nur mit Rückhalt des Managements

Agil agierenInhalte, Prozesse und Werkzeuge kontinuierlich verbessern

Regelmäßige AbstimmungRetrospektiven, Stand-ups etc. zur Gewohnheit werden lassen

Teamwork Spaß an der Arbeit und Erfolgserlebnisse schweißen zusammen

Erfolgsfaktoren für DocOps

Mehrfachrollen vermeiden Gerade bei Kleinunternehmen sind Ressourcen begrenzt

Alte Prozesse/Systeme schnell ablösen DocOps setzt Wandel in den Köpfen und eine Plattform voraus

Andere Prioritäten setzenEtwa die Zufriedenheit von Kunden und Mitarbeitern

Feedback ermöglichenum Nutzen zu erhöhen und Erfolge zu messen

Fazit

Viele Köche verderben den Brei?“ ”DocOps

Nein, im Gegenteil!

DocOps löst Silodenken auf

agile Prozesse

Rollenverständnis KommunikationFeedback

Content CollaborationAnalytics Automatisierung

DocOps

Blick aufs Ganze

info@k15t.com @k15tsoftware www.k15t.com Heute: Martin

http://FV08.honestly.de

Fragen / Diskussion

Weitere Infos: www.k15t.com/docops