Online-Hilfe und Konzept für die Integration von Code-Dokumentation

Ziel des Projekts war es, eine Online-Hilfe für eine Lokalisierungssoftware zu erstellen. parson unterstützte SICK dabei redaktionell und entwickelte eine topic-basierte Informationsarchitektur für die Online-Hilfe.

Kundenzitat

Die Arbeit mit der parson AG war für uns professionell, flexibel ins Tagesgeschäft einzubinden und das redaktionelle Know-How auf hohem Niveau. Wir bedanken uns sehr für die gute Zusammenarbeit.

Marco Bohnert, Application Engineer LiDAR Localization, SICK AG

Ziele und Erfolge

Ziel des Projekts war es, eine Online-Hilfe für die Lokalisierungssoftware LiDAR-LOC zu erstellen. parson unterstützte SICK dabei redaktionell und entwickelte eine topic-basierte Informationsarchitektur für die Online-Hilfe. Aufgrund des engen Zeitrahmens wurde die Dokumentation direkt auf Englisch und größtenteils in Remote-Arbeit erstellt. Langfristig sollen die Beschreibungen von Steuerbefehlen, die automatisch aus den Code Kommentaren der Entwickler erstellt werden, in die Online-Hilfe integriert werden. Dafür entwickelte parson ein Fachkonzept, damit alle Informationen zur Bedienung des Produkts – sowohl über die Web-Oberfläche als auch per Steuerbefehl – in einem Informationsprodukt verfügbar sind.

Unsere Leistungen im Einzelnen

  • Entwicklung einer topic-basierten Informationsarchitektur für die Online-Hilfe auf Basis der DITA-Architektur in Abstimmung mit Ansprechpartnern und Redakteuren der SICK AG
  • Erstellung einer englischen Dokumentation zur Lokalisierungssoftware
  • Abstimmung mit verschiedenen Geschäftsbereichen zur Einhaltung von unternehmensweiten Schreibvorgaben und Terminologie
  • Erstellen eines Fachkonzepts für die Integration von automatisch generierten Steuerungsbefehlen in die Online-Hilfe
  • Projektmanagement in Absprache mit Ansprechpartnern der SICK AG
  • Review- und Freigabeprozesse sowie Koordination der Zusammenarbeit mit fachlichen Ansprechpartnern und Technischer Redaktion von SICK über Atlassian Confluence

Einblicke

Ausschnitt eines Concept-Topics
Beispiel für ein Task-Topic

 

Ausschnitt aus Produktbeschreibung

Über SICK AG

Die SICK AG ist ein weltweit agierender Hersteller von Sensoren für die Fabrik-, Logistik- und Automatisierungstechnik.