| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 |
|
technische kommunikation | 21.Jahrgang | 5 / 1999 | Seite 58 IEEE 1063 und VDI 4500, Blatt 2 Neue Normen und Richtlinien von Carl-Heinz Gabriel Wer sich rechtzeitig über neue Normen und Richtlinien informiert, gewinnt einen wichtigen Informationsvorsprung gegenüber dem Wettbewerb. In dieser Ausgabe berichtet Carl-Heinz Gabriel über einen neuen amerikanischen Standard zur Software-Benutzungsdokumentation und über die entstehende VDI-Richtlinie 4500, Blatt 2, zur unternehmens-internen Dokumentation. 1. IEEE 1063 Standard for Software User Documentation In einer Internet-Arbeitsgruppe wurde in der Verantwortung des Software Standards Committee der IEEE Computer Society der alte Standard IEEE 1063 aus dem Jahre 1987 innerhalb eines Jahres komplett überarbeitet und den heutigen Techniken und Verfahren angepaßt. Unter der Leitung der Chairperson Annette D. Reilly und Secretary Philip Bernick haben 40 Arbeitsgruppenmitglieder, darunter vier tekom-Mitglieder, ausschließlich über das Internet in englischer Sprache korrespondiert und den Entwurf, Stand 28. Mai 1999, erarbeitet. Der Standard gilt sowohl für gedruckte als auch für elektronische Dokumentation für die Nutzung von Software. Er betont, daß zu Beginn der Dokumentationsplanung die Software, die Benutzungsoberfläche, die Aufgabe, die die Benutzer mit der Software durchführen sollen, klar identifiziert werden müssen. Erfolgreiche Benutzungsdokumentation ist zusätzlich zu den in diesem Standard niedergelegten Forderungen zur Struktur, zum Inhalt und Format auch das Ergebnis sorgfältiger Zielgruppenanalyse, sorgfältiger Software- und Dokumentationsentwicklung und guten Schreibstils. Schließlich wird ein Test zeigen, ob die Benutzungsdokumentation leicht durch die vorgesehene Personen für den vorgesehenen Zweck anwendbar ist. Auf ca. 17 Seiten werden neben Einleitung, Überblick und Anwendungsbereich folgende Themen behandelt:
Der Anhang (informativ) enthält eine Bibliographie und eine Empfehlung “Indexing software user documentation” und einen alphabetisch sortierten Index. Die Kenntnis dieses Standards ist für alle nützlich, die sich mit der Erstellung von Dokumentation für die Nutzung von Software befassen müssen. 2. Die neue Richtlinie VDI 4500, Blatt 2 Voraussichtlich im Herbst 1999 wird der VDI den Entwurf für einen weiteren Teil der VDI-Richtlinie 4500 herausgeben. Die Richtlinie VDI 4500 “Technische Dokumentation” behandelt die Erstellung von technischer Dokumentation. Während die Richtlinie VDI 4500, Blatt 1, die grundlegenden Anforderungen an Benutzungsinformationen als Schnittstelle zwischen Hersteller und Anwender nach allgemeinen Rechtsgrundlagen definiert, soll die Richtlinie VDI 4500, Blatt 2, Hilfestellung für Art, Inhalt und Ausführung unternehmensinterner technischer Dokumentation geben, die aufgrund von Rechtsnormen, technischen Normen oder öffentlichen Forderungen notwendig ist. Hauptpunkte aus dem Inhaltsverzeichnis werden sein: Grundlagen, Aufgaben und Inhalte der unternehmensinternen technischen Dokumentation
Dokumente im Produktlebenszyklus
Erstellen, gestalten, verteilen – wirtschaftlich dokumentieren
Anhang Ein Glossar, ein Literaturverzeichnis und ein Index werden die Richtlinie abrunden. Zielgruppe Diese Richtlinie wendet sich an Unternehmer und Führungskräfte, die für die Dokumentation entlang des Lebensweges eines Produktes verantwortlich sind. Auf der Grundlage rechtlicher Anforderungen will die VDI Richtlinie 4500, Blatt 2, Mittel und Wege beschreiben für die Erstellung einer unternehmensinternen Technischen Dokumentation, die dem Stand der Technik entspricht und bei einer Überprüfung im Schadensfall rechtlich bestehen kann. Interessenten können nähere Informationen beim tekom-Ressort “Normen, Richtlinien und Gesetze” oder bei der tekom-Geschäftsstelle erfahren. Carl-Heinz Gabriel ist Dipl.-Ing. der Fachrichtung Elektrotechnik und hat in über 35-jähriger Berufstätigkeit in Qualitätskontrolle, Akquisition, Service und Beratung umfangreiche Erfahrungen im Umgang mit technischer Dokumentation auch als Ersteller von Richtlinien und als Projektleiter für die Bearbeitung technischer Dokumentation in internationalen Projekten gesammelt. Er hat mehrfach als Mitglied von Prüfungskommissionen bei der Abschlußprüfung Technischer Redakteure mitgewirkt und hat im Sinne der tekom die DIN V 8418, den neuen ISO Guide 37 und die VDI-Richtlinie 4500 aktiv mitgestaltet. | Nr : 889 | |
|
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Select the conference site 