CCD 2011: Dokumentieren im Wiki (Tobias Anstett)

Tobias Anstett, September 27, 2011

Dokumentieren im Wiki

CCD2011 Frankfurt, 27. September 2011


Referent

• Dipl. Inf. Tobias Anstett

• Gründer und CTO von K15t Software

• Autor und Referent

• Wiki-basierte Dokumentation

• Sicherheitskonzepte im Cloud Computing

• Business Process Management


Firma

• Wir sehen in Wiki-basierten Konzepten und Technologien die Zukunft für Informationsportale und -plattformen.

• Wir entwickeln Werkzeuge für Wiki-basierte Dokumentation und strategisches Content Management.

• Als Produkt-getriebene Firma stellen wir mit unseren Scroll Plugins die Werkzeuge dazu bereit.


Einleitung

Your Wiki is not Wikipedia


Wikipedia

Wikipedia ist ein gutes Beispiel für kollaborativ erstellte Inhalte

• Dezember 2010

• 8579 Artikel wurden täglich eingestellt

• davon 433 aus Deutschland


Your Wiki is not Wikipedia

Ein Enterprise-Wiki ist ein Wiki, welches typische Funktionalitäten bietet, die für

Unternehmensanwendungen notwendig sind. Enteprise-Wikis sind ein wesentlicher Baustein im

Gesamtkontext von Enterprise 2.0.

“ “


Enterprise Wikis

IntranetKollaborationWissensmanagement

Web Publishing Business Intelligence Extranet

Dokumentation Shared Drives Blogging


Enterprise Wikis

IntranetKollaborationWissensmanagement

Web Publishing Business Intelligence Extranet

Dokumentation Shared Drives Blogging


Kollaborative Dokumentation

Web 2.0 - eine Kultur des Mitmachens


Wikis in der Dokumentation

• Schwerpunkt auf kollaborativen und sozialen Aspekten bzw. Funktionen bei der Erstellung und Bereitstellung von Inhalten

• Warum sich ein Wiki für Dokumentation

• Wikis als zentrale Ablage für alle Dokumente

• Wikis fördern die Mitarbeit an der Dokumentation

• Wikis machen Wissen besser verfügbar


Publikationsprozess

• Ein Publikationsprozess beinhaltet im allgemeinen die Phasen:

• Planung

• Erstellung

• Qualitätssicherung

• Publikation

• Feedback


Planung


Planung: Inhalte im Wiki

Wikis werden oftmals als eine chaotische Sammlung von Informationen beschrieben

• Historisch bedingtes Vorurteil (Technologie)

• Fehlende Einführungsstrategie (von Einzelpersonen bzw. Einzelprojekten getrieben)


Planung: Struktur - Bereiche

Spaces (Bereiche) gruppieren Inhalte sowohl logisch als auch physisch

• Abteilungen

• Projekte

• Produktgruppen / Produkte

• Dokumentation

• ...


Planung: Struktur - Seiten

Pages (Seiten) erlauben es hierarchische Strukturen zu schaffen

• Eine Seite kann 0-n Kindseiten haben

• Kindseiten können alphabetisch oder benutzerdefiniert sortiert werden


Planung: Struktur - Vorlagen

Templates (Vorlagen) erlauben es dem Anwender Inhalte vorzudefinieren

• Templates können global und pro Space definiert werden

• 3rd Party Tools erweitern die Standardfunktionalität für Formulare

• Scaffolding (Customware) für Confluence 3.x

• Scroll Wiki Forms (K15t Software) für Confluence 4.0


Erstellung


Erstellung: Confluence 4.0 Editor


Erstellung: Formulare

• Frei: Der Autor kann frei über die Form der Inhalte entscheiden

• Semi-strukturiert: Eine Vorlage gibt einen Rahmen vor, welche Inhalte der Autor schreiben soll

• Formular-basiert: Das Formular gibt dem Autor die Felder bzw. Bereiche vor, die er ausfüllen muss

Confluence State of the UnionScroll Wiki Forms


Confluence State of the Union: Scroll Wiki Forms


Erstellung: Wiederverwendung

Wiederverwendung findet auf der Ebene von Seiten statt

• Bausteine können sowohl intern (selber Bereich) oder aus einem anderen Bereich referenziert werden

• Macros erlauben des Weiteren die Einbindung externer Datenquellen


Qualitätssicherung


Qualitätsicherung: Workflows

Wikis verfolgen den Ansatz einer ex-post Qualitätsicherung

• Autoren schreiben und aktualisieren Inhalte

• Inhalte werden aufgrund von Feedback anderer Nutzer kontinuierlich verbessert

Workflows bilden redaktionelle Prozesse ab

• Status, Transitionen, Aktionen und Rechte

• Ad hoc Workflows (Comalatech) für Confluence 3.x /4.0


Publikation


Publikation: Versionierung

Confluence versioniert seinen Inhalt per default

• Für jede Seite existiert eine Seitenhistorie

• Ganze Bereiche können über das Copy Space Plugin (Atlassian) kopiert und danach mittels Rechtemanagement eingefroren werden


Publikation: Cross Instance Publishing

Durch sogenannte Space-Backups kann Inhalt von einem Confluence System auf ein anderes übertragen werden.

• 3rd Party Tools erweitern die Standardfunktionalität

• Content Publishing Plugin (Comalatech)

• Ermöglicht Draft Seiten in einen definierten Bereich zu publizieren

• Ist über Confluence Instanzen hinweg möglich


Publikation: Single Source Publishing

Confluence als Quelle aller Informationen für

• Exportiert nach PDF und Word

• 3rd Party Tools erweitern die Standardfunktionalität

• Scroll Wiki Exporter (K15t Software)

• Multiple Ausgabeformate

• PDF, Word, EclipseHelp, DocBook, EPUB

• Zielgruppenspezifische Aufbereitung

• Zielgruppenspezifisches Layout

(1/6)


Publikation: Single Source Publishing (3/6)

Launch PadScroll Wiki PDF Exporter


Launch Pad: Scroll Wiki PDF Exporter (1/6)

Template Designer {


Launch Pad: Scroll Wiki PDF Exporter

ZielgruppensepzifischesLayout

ZielgruppensepzifischeAufbereitung {

(2/6)



Metainformationen {



Linking Strategies {



Export Progress

Export Log

(5/6)



Save Export Settings

(6/6)

Best Overall Plugin - Codegeist 2011Scroll Wiki EPUB Exporter


Codegeist: Scroll Wiki EPUB Exporter

Confluence Demonstration Spacein iBooks


Feedback


Feedback: Dokumentation als Marketinginstrument

Gute Dokumentation kann ein wichtiges Marketinginstrument sein

• Qualität der Dokumentation bzw. bereitgestellten Informationen als Indikator für Produktqualität

Kunden zu involvieren bedeutet die Kunden kennenzulernen

• Wiki erlaubt Kommentar- und Bewertungsfunktionen

• Wiki kann gezielt für Suchmaschinen optimiert werden

• Möglichkeit zur Rückmeldung kann in viele digitale


Kontakt Informationen

Weiter Informationen erhalten Sie ...

• unter to http://www.k15t.com

• bei [email protected]

Oder treffen Sie uns persönlich ...

TC-World19. Oktober

@k15tsoftware

http://k15t.com

http://k15t.com

mailto:[email protected]

mailto:[email protected]


VIELEN DANK !

Technology

CCD 2011: Dokumentieren im Wiki (Tobias Anstett)