Hochmoderne Softwaredokumentation für Industrie-Software manage.ID

Ziele und Erfolge

POSSEHL Identification Solutions (PID) benötigt moderne Softwaredokumentation für manage.ID, eine industrielle Softwarelösung zur Anbindung von Unternehmenssystemen (z.B. ERP, MES) an Identifikations-/Etikettiersysteme. PID möchte manage.ID mit einer lauffähigen Dokumentation auf der Interpack-Messe im Mai 2023 präsentieren.

Innerhalb von rund drei Monaten erstellte parson die Softwaredokumentation in DITA-XML inklusive vereinfachter Grafiken (SUI) zur Veranschaulichung der Benutzeroberfläche. Außerdem konfigurierten wir das Oxygen-Framework und die DITA-Dokumentenstruktur. PID kann manage.ID nun auf der Interpack-Messe mit einer lauffähigen Version der Dokumentation präsentieren.

Unsere Leistungen im Einzelnen

Anforderungs-Workshop

Im Vorfeld des Dokumentationsprojekts organisierten wir einen Anforderungsworkshop, in dem PID und parson einen priorisierten Inhaltsplan und eine grobe Themenstruktur für das Release der Dokumentation im Mai 2023 entwickelten.

Softwaredokumentation erstellen

  • Technische Dokumentation auf Englisch für manage.ID in DITA-XML erstellen
  • Screenshots als SUI-Grafiken einbinden
  • Diagramm der Systemarchitektur erstellen
  • Terminologie verwalten und Styleguide für die Dokumentation erstellen
  • Review-Zyklen mit den Fachexperten von PID organisieren und die Review-Ergebnisse in die Dokumentation integrieren. In der Anfangsphase des Projekts organisierte parson mehrere Review-Zyklen mit kleineren Textabschnitten, um Schreibstil und Terminologie anzugleichen und die Einführung zu erleichtern.
  • Die Dokumentation als Oxygen WebHelp und PDF ausgeben

Einblicke

Documentation PID: Concept-Topic
manage.ID Online-Dokumentation: Concept-Topic
 
Documentation PID: SUI
manage.ID Online-Dokumentation: SUI-Grafik
 
Documentation PID: Task-Topic
manage.ID Online-Dokumentation: Task-Topic

Framework konfigurieren

  • Oxygen-Framework und DITA-Dokumentenstruktur in einem Dokumentations-Repository einrichten
  • Layout der Oxygen WebHelp entsprechend der CI von PID konfigurieren

Ausblick

PID wird manage.ID nach der Interpack-Messe weiterentwickeln und neue Funktionen implementieren. Auf Wunsch von PID wird das parson-Team die neuen Funktionen dokumentieren und die Online-Hilfe erweitern.

Über POSSEHL Identification Solutions

POSSEHL Identification Solutions (PID) ist Teil der international agierenden POSSEHL-Gruppe mit Sitz in Lübeck, Deutschland. Die POSSEHL-Gruppe umfasst heute mehr als 200 Unternehmen in mehr als 30 Ländern. Derzeit beschäftigt POSSEHL weltweit rund 13.000 Mitarbeiter. PID bündelt die Aktivitäten der Possehl-Gruppe in den Bereichen Print & Apply-Lösungen und Etikettiersysteme.