Neue Strukturen für Dokumentationsinhalte und Redaktionsberatung
Mit der Unterstützung von parson konnten wir in kurzer Zeit für SMA die Topic-Strukturen definieren und erste Anleitungen im Produktivsystem auf den topic-basierten Ansatz umstellen. Dank parson haben wir einen professionellen und sicheren Einstieg in das Projekt bekommen und wurden zu jeder Zeit konstruktiv beraten. Wenn wir auf Probleme gestoßen sind, konnte parson uns schnell und kompetent bei der Lösungsfindung unterstützen. Wir freuen uns auf weitere gemeinsame Projekte.
Ziele und Erfolge
Die SMA Solar Technology AG stellt die Technische Dokumentation auf topic-basiertes Schreiben um, um mittelfristig eine dynamische Content-Delivery zu unterstützen. Zu diesem Zweck sollte die Betriebsanleitung einer Produktgruppe im Redaktionssystem Schema ST4 modularisiert werden. Dabei wurden die Inhalte mit Metadaten klassifiziert und auf Grundlage von SMA-spezifischen Sequenzmustern umstrukturiert.
parson unterstützte SMA durch Content-Engineering und Redaktionsberatung anhand eines Prototyps. Das Content-Engineering baute auf den Ergebnissen von Workshops auf, die parson im Januar und April 2022 mit dem Team von SMA durchführte.
Unsere Leistungen im Einzelnen
Content-Engineering für topic-basierte Dokumentation und Entwicklung des Prototyps
- Für die Entwicklung des Prototyps analysierte parson die bestehende Betriebsanleitung hinsichtlich Topic-Orientierung, Strukturierung und Informationsarten.
- Für die Modularisierung und das Variantenmanagement der Prototyp-Inhalte sowie für die Planung und Organisation des Content-Engineerings arbeitete parson eine Klassifikationsmatrix aus.
- Anschließend wurden die Prototyp-Inhalte entsprechend der Klassifikationsmatrix neu angelegt, überarbeitet und bei Bedarf modularisiert.
Redaktionsberatung, Dokumentation und Projektmanagement
- In Content-Engineering-Sessions mit dem Kunden stellte parson den Wissenstransfer sicher, diskutierte Optimierungspotentiale und führte Änderungen gemeinsam durch.
- parson entwickelte Vorschläge für die Überarbeitung und Umstrukturierung einzelner Prototyp-Topics.
- parson dokumentierte Festlegungen, Regeln und Empfehlungen, die sich während des Projektverlaufs herausbildeten. Diese können als Regeln für das topic-basierte Schreiben in den SMA-Redaktionsleitfaden übernommen werden.
- Um einen reibungslosen Projektablauf sicherzustellen, kümmerte sich parson um die Projektorganisation einschließlich Abstimmungsmeetings, Risikomanagement, Mailverkehr und Telefonkonferenzen.
Einblicke
Beispiel für Handlungsanweisung – vorher und nachher:
Beschreibende Informationen in separates Topic ausgelagert, Querverweise vereinheitlicht:
Über SMA Solar Technology AG
Die SMA Solar Technology AG ist ein global führender Spezialist für Photovoltaik-Systemtechnik. Mit über 3.500 Mitarbeiter:innen in mehr als 20 Ländern schafft das Unternehmen die Voraussetzungen für eine dezentrale, digitale und erneuerbare Energieversorgung von morgen. Ziel der von SMA entwickelten innovativen Photovoltaik-Lösungen ist es, weltweit mehr Unabhängigkeit in der Anwendung von Energie zu ermöglichen.