Technische Dokumentation in Confluence und kontext-sensitive Hilfe für SAP-Systeme München, 18.10.2012 © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Inhalt Confluence: Warum? Für wen? Wie? Aktueller Status wichtige zusätzliche Features Lessons Learned Technische Redaktion Demo Page 2 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Ausgangssituation & Ziele Das 2006 eingeführte Verfahren zur SAP-Anwenderdokumentation (basierend auf Einzeldokumenten, sog. „Wie-Dokumenten“) genügte nicht mehr den (zwischenzeitlich gestiegenen) Anforderungen: aufgezeichnete Bildschirmfolgen statt tatsächliche Information „wie weiß ich, aber warum?“ geringe User-Akzeptanz parallele Dokumentation, erstellt durch die Fachabteilungen unverhältnismäßig hoher Pflegeaufwand Lücken in der Dokumentation & Dokumentation nicht aktuell neue Anforderungen bzgl. Mehrsprachigkeit Ziele Kosteneinsparung im Betrieb (Server & Lizenzen) Aufwandsreduzierung in der Dokumentationserstellung und -pflege intuitive und moderne Benutzerführung (analog Wikipedia) inkl. Suchfunktion Mehrsprachigkeit: (untereinander verknüpfte) Dokumentation in Englisch und Russisch Nutzbarkeit zur Dokumentation anderer Verfahren Nutzbarkeit (Authoring) durch Fachabteilungen Page 3 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Zielgruppe Die Zielgruppe für die Dokumentation sind die Anwender sämtlicher Prozesse/Funktionen unseres SAP-Systems. Eckdaten: ~ 11.500 User 7 Fertigungsstandorte (DE, AUT, USA) wechselnde Projektstandorte weltweit Systemeinführung: 1998 > 100 Personenjahre Eigenentwicklung ~ 1.000 aktuelle eigenentwickelte Transaktionen Page 4 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Vision Stellen Sie sich vor, wir … hätten eine Plattform für Dokumentation aller Art, die sogar applikationsübergreifend nutzbar wäre, hätten einen Anlaufpunkt für Anwender, neue Mitarbeiter, Externe, Prüfer etc., könnten über mehrere Pfade den Weg zur gewünschten Hilfe zu finden (Verzeichnis, Schlagwortsuche, Volltextsuche, graf. Benutzerführung, Weiterleitung, Abo-Funktion, …), hätten eine Oberfläche, die jeder Anwender intuitiv bedienen kann, die Möglichkeit, in einen Dialog mit dem Anwender zu treten, besäßen ein Verfahren, in dem Anwender selbst Dokumentation erweitern oder um BU-Spezifika ergänzen könnten, ohne Barrieren wie Installation, Schulung etc., könnten auswerten, welche Inhalte wie oft genutzt werden, welche fehlen und welche verbessert werden müssen, könnten deutsche, englische (und russische) Dokumentation gemeinsam verwalten und synchron halten. Page 5 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division untersuchte Wiki-Applikationen Sharepoint Wiki, weil Sharepoint ein Standard-Verfahren von Siemens ist. MediaWiki, weil es als Plattform für Wikipedia den weltweit größten Anwenderkreis hat, es einige MediaWiki-Installationen bei Siemens gibt, es kostenlos ist. Confluence, weil es sich als Basis der Siemens Wikisphere (Corporate Wiki) bewährt hat, es bereits an Siemens-Standards (z.B. NWA* und Authentifizierung) angepasst ist, es in Sharepoint integriert werden kann ( Collaboration), es sehr günstig ist. * New Web Appearance Page 6 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Bewertung der untersuchten Dokumentationsverfahren Vollständigkeit einfache Zugriffsmöglichkeit Geschwindigkeit Kontextbasierte Verknüpfungen Ergebnis: Suchfunktionen (inkl. Volltext) Mehrsprachigkeit (Oberfläche und Inhalt) Intuitive Bedienbarkeit Einheitlichkeit der Informationsdarstellung 382 Feedbackfunktion Systemunabhängigkeit 199 Anwender-Sicht Pflegbarkeit (Neuanlage und Änderung) Auswertemöglichkeiten (Zugriffstatistik etc.) IT-Sicht 183 Berechtigungssteuerung Abofunktion auf geänderte Inhalte Kosten (Lizenz, Hardware, BuB) Appl. X Dateiverwaltung Versionierung von Inhalten (Historie) … Page 7 Oktober 2012 Jan Strate, IC RL IT CSM SCM 632 475 295 213 262 Appl. Y 337 Confluence © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Testergebnis Prototyp Confluence Rückmeldung der Tester nach Erstellen mind. einer Beispieldokumentation im Vergleich zum bisher genutzten Verfahren: Usability Content Ersteller Usability Anwender Aufwand bei ContentÄnderung Einbinden von Screenshots man muss wieder schreiben statt aufzeichnen Formatierung Geschwindigkeit Suchfunktion Paste from clipboard besser Page 8 Oktober 2012 Jan Strate, IC RL IT CSM SCM Editor “hakelig” / MarkupLanguage gleich schlechter © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Project timeline Jan Feb Mar Apr 2011 May Jun Nutzung Alt-Applikation Jul Aug Sep Nutzung Confluence Confluence 3.3.1 Internet Explorer 8 Migration Realisierung techn. Redaktion Support Siemens CT Blueprint Page 9 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Entwicklung Start mit 5 Spaces: SAP EN SAP MOL RA IT intern Draft SAP DE SAP EN SAP MOL RA IT intern Draft CAx Admin CAx DE CAx EN CCM Handbuch Sandbox SAP Entwickler Doku Champ FX Doors IC MOL LAS Red DLZ SAP DE Nach einem Jahr: anonym Page 10 Anmeldung Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Statistik: SAP-Anwender-Doku hohes Änderungsaufkommen Die Dokumentation wird auf einem aktuellen Stand gehalten. Page 11 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Statistik: Anzahl der Artikel Die Zahl der Artikel steigt gleichbleibend. Das Tool wurde von der Organisation angenommen. Page 12 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Statistik: Zugriffe auf Anwenderdoku Die Zugriffe der Anwender liegen deutlich über denen der vorherigen Applikation. hohe Akzeptanz bei den Anwendern Page 13 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Feature: Mehrsprachigkeit incl. UNICODE Dieses Feature ist für synchrone mehrsprachige Dokumentation unverzichtbar. Page 14 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Feature: Paste Image from Clipboard Dieses Feature erleichtert wesentlich das Dokumentieren z.B. mittels Screenshots, da das “Speichern als Datei” und die anschließende Auswahl der Datei über den Explorer entfällt. Page 15 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division kontextsensitive Hilfe: Transaktion Labelsuche https://docs.mobility.siemens.com/labels/lookuplabel.action?key=SAPDE&label=/SIE/TS_PP074 Über eine dynamisch zusammengesetzte URL wird sprachabhängig der Transaktionsname in den Labels des jeweiligen Spaces gesucht. Diese Logik kann prinzipiell auf andere Applikationen übertragen werden, bei denen eindeutige technische Schlüssel verwendet werden. Page 16 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division kontextsensitive Hilfe: Transaktion = 1 Label Der Transaktionsname ist genau einmal als Label vergeben (Idealfall). Die entsprechende Seite in Confluence wird direkt angezeigt. Page 17 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division kontextsensitive Hilfe: Transaktion > 1 Label Der Transaktionsname ist mehrmals als Label vergeben. Alle Confluence-Seiten mit diesem Label werden angezeigt. Page 18 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division kontextsensitive Hilfe: Transaktion Label Der Transaktionsname ist nicht als Label vergeben. Der Transaktionsname wird an die Volltextsuche übergeben. Page 19 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Lessons learned kompetente Unterstützung von Confluence-Kennern bei der Einführung unabdingbar Dokumentation ist und bleibt eine unangenehme Aufgabe Unterstützung der gesamten Dokumentationsthematik durch techn. Redakteure ist notwendig, wenn man Fortschritte bei der Dokumentationserstellung erzielen will. Jeder strukturiert anders, kümmert sich wenig um die Doku von anderen. Die Möglichkeit, Artikel miteinander zu verlinken wird wenig genutzt. Draft Space/Sandbox verhindert “unsaubere” bzw. “unstetige” Anwenderdoku Synchrone Dokumentation Deutsch/Englisch erfordert einen sehr hohen Koordinationsaufwand und ist teuer. Zugriffseinschränkungen auf Seitenebene sollten die Ausnahme bleiben. Eine hierarchische Struktur der Seiten hilft bei der Navigation (Start mit flacher Struktur). Die Kommentarfunktion bleibt für Anwender ausgeschaltet: Notwendiger Prozess hierzu ist mit normalen Mitteln nicht beherrschbar. Page 20 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Technische Redaktion Die gesamte Palette Confluence-bezogener Aufgaben wird durch eine dreiköpfige techn. Redaktion dauerhaft unterstützt. Die Aufgaben der techn. Redakteure umfassen: Überführung „alter“ Dokumentationen nach Confluence (schleichende Migration) Hilfestellung beim Arbeiten mit Confluence für die Dokumentationsersteller 1. Anlaufstelle bei techn. Problemen mit Confluence Bug-Tracking, Evaluierung und Test neuer Features Qualitätssicherung (Labeling,Language-Makro etc.) Schnittstelle zum Übersetzungsprozess Regelmäßige Confluence-Schulungen Neue Dokumentation wird (u.a. mit Hilfe oder durch techn. Red.) im Draft-Space erstellt. Nach Überprüfung durch den Verantwortlichen für diese Doku, wird sie in den produktiven Space umgehängt. Die anschließende Pflege obliegt dem Verantwortlichen direkt im produktiven Space. Page 21 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division Kontakt Page 22 Oktober 2012 Jan Strate, IC RL IT CSM SCM © Siemens AG 2012 Infrastructure & Cities Sector, Rail Systems Division
© Copyright 2025 ExpyDoc