Upload
k15t-software-gmbh
View
510
Download
1
Embed Size (px)
Citation preview
Martin Häberle Diplom-Technikredakteur (FH)Consultant, K15t Software
@Lesegefahr
Wer bin ich??
Mythos und Wahrheit: Wikis für die Technische Dokumentation
Vortrag bei der tekom-Regionalgruppe Stuttgart 30. April 2014 !
Martin Häberle, K15t Software GmbH
Heute wird aufgeräumt: 10 Wiki-Mythen unter der Lupe
We believe that wiki-based technologies will be the future for technical documentation.
“
”
Wiki, or what?
?
• 30 Millionen Artikel in über 280 Sprachen
• 1,7 Millionen Benutzer (und unzählige Anonyme)
• Deutsche Wikipedia: über 6.100 aktive Autoren
!
• Regionales Wiki mit rund 24.000 Artikeln und 29.000 Bildern
• 105 aktive Nutzer (6.000 Anmeldungen)
Erfolgreiche Wikis „da draußen“?
bieten typische Funktionen, die für Unternehmensanwendungen notwendig sind:
• Strukturierung
• Schnittstellen
• Versionierung
• Benutzerzugriffskontrolle
Enterprise-Wikis?
Arbeiten im Wiki
1
In Wikis zu arbeiten ist doch immer ein einziger K(r)ampf
mit dieser Wiki-Syntax
1
”
Aussage:
“
In vielen Fällen: wahr! Leider!
'''Wikipedia''' [{{IPA|ˌvɪkiˈpeːdia}}] ist ein am [[15. Januar|15. Januar]] [[2001]] gegründetes Projekt zur Erstellung eines [[Freie Inhalte|freien]] [[Onlinelexikon]]s in zahlreichen Sprachen.
1
Es gibt aber auch Ausnahmen1
• Grafischer Editor – „WYSIWYG“ • Drag and Drop • Tastenkürzel für Überschriftenformate etc.
Editieren wie es sein sollte1
Besser:
“
”
Mit klassischen Wikis zu arbeiten ist ein einziger K(r)ampf mit der
Wiki-Syntax“
1
2
Word vs. Wiki
Mit Word und im Dateisystem arbeiten wir doch viel effizienter
2 Aussage:
“
”
• … nur eine Person Inhalte erstellt/bearbeitet;
• … diese Person exzellent MS Word beherrscht;
• … Inhalte nur an einer Stelle veröffentlicht werden;
• … die Infos nur in diesem Dokument benötigt werden.
Stimmt! Allerdings bloß wenn …2
z.B. thematisch, nach Datum, nach Version
Ablage im Dateisystem2
• Nutzer arbeiten komfortabel im Browser
• Alle Inhalte werden zentral im Wiki gepflegt
• Inhalte/Seiten werden „getaggt“ + zusammengestellt
• Versionierte Dateianhänge für Seiten
• Änderungshistorie; ggf. explizite Versionierung
• Für alle transparent, was sich ändert
In Enterprise Wikis2
Word ist so social wie ein Pfund Zwiebelmett.
Kurz:2
3
Struktur
Wikis haben keine Struktur und man findet nichts darin
3 Aussage:
“
”
• Historisch bedingtes Vorurteil (Technologie)
• Pauschal nicht gültig; Enterprise Wikis beheben genau diese Mängel.
• Fehlende Einführungsstrategie (von Einzelpersonen bzw. Einzelprojekten getrieben)
Wikis als „chaotische Info-Sammlung“3
• Bereiche (thematisch, nach Zugriff, je Handbuch …)
• Hierarchische Strukturen (beliebig tiefe Unterseiten)
• Finden statt suchen (Volltext-Indizierung)
• Labels zum Gruppieren von Seiten
• Links zwischen Seiten, Bereichen
• Vorlagen für einheitliche Seitenstrukturen
Beispiel3
4
Wiederverwendung
Wiki-Inhalte lassen sich nicht modular wieder verwenden
4 Aussage:
“
”
Seitenstruktur mit Homepage
Wiederverwendung-Bibliothek
• Nur für Autoren sichtbar • Beliebig inkludierbar • Seitentitel: _Modulname • auf Wunsch versioniert
Wiederverwendung mit Confluence4
5
Versionierung / Varianten
Kein Wiki geht vernünftig mit Versionen und Varianten um
5 Aussage:
“
”
Ein (Enterprise) Wiki ist kein klassisches CMS, sondern eine Plattform für Kollaboration und Wissensmanagement.
Gute Nachrichten: Wikis wie Confluence sind erweiterbar und es gibt zahlreiche Add-ons für verschiedene Anwendungsfälle.
Ertappt!5
Versionierung
Varianten-Management
Mehrsprachigkeit
Übersetzungs-Import/Export
Mehrfache Seitentitel, SEO
5 Content Management Add-ons
6
Schnittstellen
Aber für unsere Sprach-Tools gibt’s keine Schnittstellen, oder?
6 Aussage:
“
”
• TMS-Export/Import via XML-Schnittstelle • Beliebig viele Sprachen • Delta vs. Komplettübersetzung
Übersetzungs-Management6
via Acrolinx • Terminologie-Check • Stilregeln • Grammatik und Rechtschreibung
Sprachprüfung6
Sprachprüfung6
7
Qualität
Wenn jeder alles bearbeiten darf, geht die Qualität den Bach runter
7 Aussage:
“
”
Keiner hat ein Interesse daran, fehlerhafte Inhalte beizusteuern. !
Ausnahme: Vandalismus (gibt es in Enterprise Wikis nicht)
Fehlerhafte Inhalte7
Sind auch im Wiki möglich. Nutzer werden aber zumeist ohne Not eingeengt.
Beschränkungen und Freigabe-Workflows7
Motivierte Wiki-Autoren verbessern sich gegenseitig!
Ex-post-Qualitätssicherung7
Statt Restriktionen lieber einfache Bearbeitung durch möglichst viele Benutzer.
Eine Folge ist die Auflösung der Grenze zwischen Inhalts-Produzenten und -Konsumenten.
The Wiki way7
Nur weil viele Technische Redaktionen ein spezielles CMS mit Workflows etc. einsetzen, ist die Informationsqualität nicht automatisch höher.
„Garbage in – garbage out“7
Redaktionssysteme werden oft nicht optimal genutzt (siehe Kennzahlen zur Wiederverwendung)
CMS-Studie der tekom:7
• sind komplex, auch in der Bedienung;
• können nur von einem extrem begrenztem Anwenderkreis genutzt werden.
• „Informations-Silos“
Redaktionssysteme …7
8
Single-Source Publishing
Single-Source Publishing und Druckausgabe für Wikis ist reines
Wunschdenken
8 Aussage:
“
”
Ausgabe in PDF, HTML, Word (einzelne Seiten)ist eine Standardfunktion von Confluence
Erweiterte Ausgabe über Add-ons
Exportformate8
9
Nutzung
Niemand liest das Wiki, oder trägt freiwillig Inhalte bei
9 Aussage:
“
”
9 Alles ein Frage der Unternehmens-Kultur
• alle Mitarbeiter nutzen Confluence (+ JIRA)
• Intranet (Organisation, Prozesse, Ablage, Besprechungsprotokolle)
• Software-Spezifikationen und Projektinfos
• Dokumentation für alle Scroll-Produkte
• Website und Blog auf Confluence
9 „Drink your own Champagne“
Ordnet und reduziert Chaos
Motiviert und hilft
Schafft Strukturen
Baut einen Grundstock
Repariert „Broken Windows“
Ist die „1“ in der 90-9-1-Regel
Unverzichtbar: Wiki-Gärtner9
10
Für Kunden
Ein Wiki mag intern etwas taugen, aber doch nicht für Kunden
10 Aussage:
“
”
… denn Dokumentation endet nicht bei deren Veröffentlichung.
Jetzt geht’s erst richtig los!10
Wiki
Technische Redakteure
Produktmanager
Entwickler /Ingenieure
Fachexperten
Übersetzer
Qualitätssicherung
Marketing
Dienstleister
Partner
Kunden
Lieferanten
Händler
InteressentenFeedback !
(Kommentare) !
Fragen
Doku !
Produkt-infos !
Fachwissen
• Produktdokumentation
• Öffentlicher Wiki-Zugang
• alle dürfen kommentieren
• Anregungen, Fragen und Antworten
• Bereich für Austausch mit Kunden/Partnern
https://confluence.atlassian.com/display/DOC/Cheese+Macro
Beispiel Atlassian10
Wiki-basierte Dokumentation ist nicht bloß möglich, sondern wird x-fach erfolgreich praktiziert.
Fazit
Ein Wiki ist für viele Anwendungsfälle nicht nur gleichwertig, sondern sogar haushoch überlegen.
Fazit
Die allermeisten Wiki-Mythen sind zu pauschal, um wahr zu sein. Das heißt sie sind falsch.
Fazit
Fragen & Antworten
?
[email protected] @k15tsoftware www.k15t.com Heute: Tobias, Nils, Martin
In Kontakt bleiben@
Einladung: Webinar am Mittwoch, 7. Mai „Content Management mit Confluence“