Software & IT
Unsere Software- und IT-Dokumentation muss korrekt, vollständig, verständlich und zielgruppengerecht sein, damit Anwender Software sicher und zweckmäßig nutzen können. Sie umfasst unter anderem Beschreibungen von Funktionen, Systemvoraussetzungen, Installation, Konfiguration, Bedienung, Fehlerbehebung, Updates und Release Notes sowie – sofern erforderlich – Aspekte zu IT-Sicherheit und Datenschutz.
Spätestens mit dem Inkrafttreten des Cyber Resilience Acts sowie der neuen EU-Maschinenverordnung (EU) 2023/1230 wird Software deutlich umfassender betrachtet und muss zusätzliche, klar definierte Sicherheitsanforderungen erfüllen.
Unsere Informationsprodukte
Benutzerdokumentation
Benutzerdokumentation orientiert sich an den Aufgaben und Kenntnissen der jeweiligen Zielgruppen, etwa Endanwendern, Administratoren, Entwicklern oder Auditoren. Sie wird in geeigneten Formaten und Medien bereitgestellt, beispielsweise als Online-Hilfe, PDF, In-App-Hilfe oder API-Dokumentation.
Gute Benutzerdokumentation ist usability-geprüft, leicht auffindbar, barrierearm zugänglich und wird kontinuierlich aktualisiert. Bei der Erstellung berücksichtigen wir geltende Normen wie die IEEE 26514:2022 „Software- und System-Engineering – Anforderungen an Designer und Entwickler von Benutzerdokumentationen“.
Topic-basierte Online-Hilfe
Topic-basierte Online-Hilfe besteht aus klar abgegrenzten, in sich geschlossenen Informationseinheiten mit jeweils einem eindeutigen Thema und Nutzungsziel. Jede Einheit folgt einer einheitlichen Struktur, beispielsweise mit Titel, Kurzbeschreibung, Kontext, Handlungsschritten und weiterführenden Hinweisen. Dadurch finden sich Nutzer schnell zurecht und erhalten gezielt die benötigten Informationen.
Abhängig vom konkreten Bedarf empfehlen wir unseren Kunden geeignete CCMS- oder Autoren-Tools.
Release Notes
Release Notes sind klar strukturiert, zielgruppengerecht und in präziser, verständlicher Sprache formuliert. Eine feste Gliederung und der Fokus auf wesentliche Inhalte – etwa Überblick, neue Funktionen, Verbesserungen, Bugfixes und bekannte Probleme – sind dabei entscheidend. Zudem achten wir auf eine konsistente Terminologie im Einklang mit Produkt und Dokumentation und stimmen die Inhalte eng mit Produktverantwortlichen und Support ab.
Software-Risikobeurteilung
Mit dem Cyber Resilience Act und der neuen EU-Maschinenverordnung (EU) 2023/1230 müssen sicherheitsrelevante Softwarekomponenten spezifische Sicherheitsanforderungen erfüllen. Risikobeurteilungen müssen ausdrücklich auch Risiken aus Software, Softwareänderungen, Vernetzung und zukünftigen Updates berücksichtigen. Handlungsempfehlungen für IT-Sicherheit und Risikobeurteilung liefert insbesondere die Normenreihe IEC 62443, vor allem Teil 3-2.
SBOM (Software Bill of Materials)
Eine SBOM (Software Bill of Materials) ist gemäß den Vorgaben des Cyber Resilience Act (CRA) eine strukturierte „Stückliste“ aller Softwarekomponenten eines Produkts. Sie enthält Metadaten zu Herkunft, Versionen, Abhängigkeiten und Lizenzen. Typische Datenfelder sind unter anderem Komponentenname, Version, Lieferant, Lizenzinformationen und Abhängigkeitsbeziehungen.
Auf Basis der SBOM können Hersteller transparent nachweisen, welche Softwarekomponenten in einem Produkt enthalten sind, und Sicherheitslücken gezielt identifizieren und nachverfolgen.
