Struktur Dokumentation Software



Yüklə 54,97 Kb.
tarix07.12.2017
ölçüsü54,97 Kb.

Physikalisch-Technische Bundesanstalt

Merkblatt über die
Anforderungen an die Softwaredokumentation

Stand: Februar 2006


Herausgegeben von der PTB-Arbeitsgruppe 1.14 "IT-Wägetechnik“
Für Rückfragen steht zur Verfügung: Marcus Link

Tel.: 0531 – 592 1146

Fax: 0531 – 592 1105

E-mail: marcus.link@ptb.de

Internet: http://www.ptb.de/de/org/1/11/114/index.htm

Allgemeine Hinweise

Grundlage dieses Merkblatts ist der WELMEC-Guide 2.3 „Leitfaden zur Prüfung


von Software (Waagen)“ für nichtselbsttätige und selbsttätige Waagen sowie der
WELMEC-Guide 7.2 „Software Guide (Measuring Instruments Directive 2004/22/EC)“.
Siehe auch www.welmec.org.
Bei bereits bestehender, anders strukturierter Softwaredokumentation, genügen
eventuell Querverweise auf die bestehende Dokumentation.


Struktur der einzureichenden Softwaredokumentation bei freiprogrammierbaren Waagen und Wägesystemen

Inhaltsverzeichnis

Physikalisch-Technische Bundesanstalt 1

Merkblatt über die


Anforderungen an die Softwaredokumentation 1

Stand: Februar 2006
1

Allgemeine Hinweise 1



1. Einleitung 2

1.1Funktion der Software 2

1.2 Einsatzgebiet der Software 2

2. Hardware-Umgebung 2

2.1 Software läuft auf einem „Embedded-System“ (built for purpose) 2

2.2 Software läuft auf einem PC-System (universal computer) 3

2.3 Anzahl und Typ der anschließbaren Waagen 3

2.4 Anschließbare Zusatzeinrichtungen 3

2.5 Verbindung zu Netzwerk, Server, o.ä. 3

2.6 Sonstige Hardware-Komponenten 3

3. Funktionalität und Bedienung der Software: 3

3.1 Vollständige Beschreibung der Funktionalität der Software: 3

4

3.2 Bedienung der Software: 4



3.3 Programmierbarkeit der Software 4

3.4 Benutzeroberfläche geschlossen 4

3.5. Benutzeroberfläche nicht geschlossen 4

4. Struktur der Software 4

4.1 Trennung zwischen eichpflichtigen und nicht eichpflichtigen Programm- Modulen 4

4.2 Keine Trennung zwischen eichpflichtigen und nicht eichpflichtigen Programm- Modulen 4

4.3 Eichfähige Software-Module auf mehrere Systeme verteilt 4

4.4 Beschreibung der Software-Schnittstellen 5

4.6 Typspezifische Parameter (TP) 5

4.7 Variable Werte (VW) 5

4.8 Low-Level-Treiber 5



5. Sicherungsmaßnahmen für Software und Parameter 5

5.1 Hardwaretechnische Sicherung der Software 5

5.2 Manipulationen des Programm-Codes 5

5.3 Funktionale Prüfzahl 6

5.4 Sicherung gerätespezifischer Parameter 6

5.5 Sicherung typspezifischer Parameter 6

5.6 Sicherung der variablen Werte 6

5.7Kontrollfunktionen 6



6. Software-Download 6

6.1 Software-Download ist nicht vorgesehen 6

6.3 Software-Download ist nur für nicht eichpflichtige Programmteile vorgesehen 7

6.5 Checkliste Software-Download 7



7. Informationen zur Eichung 8

7.2 Kennzeichungsschild 8

7.3 Angaben zur Software auf dem Kennzeichungsschild: 8

7.4 Anweisungen zur Eichung: 8



8. Erforderliche schriftliche Erklärungen 8

Struktur der Software Dokumentation


Die einzureichende Softwaredokumentation sollte nach folgendem Schema aufgebaut sein. Nicht zutreffende Kapitel können ausgelassen werden. Die Nummerierung der Kapitel sollte aber beibehalten werden. Beachten Sie bitte die kursiv geschriebenen Hinweise.

1.Einleitung

    1. Funktion der Software


Realisiert die Software Funktionen einer Waage?

Realisiert die Software Funktionen einer Zusatzeinrichtung?



1.2 Einsatzgebiet der Software


Hier ist das Einsatzgebiet der Software zu beschreiben; z.B. als eichfähiger Datenspeicher, als Hauptanzeige einer Waage, als Kassensystem oder spezielle Anwendungen wie z.B. Müllverwiegung.

2.Hardware-Umgebung

2.1 Software läuft auf einem „Embedded-System“ (built for purpose)


  • Beschreibung des „Embedded Systems“:

  • wesentliche Hardware-Komponenten (Prozessor, flüchtiger / nicht flüchtiger Speicher, weitere Speichermedien, Grafik, etc. )

  • Beschreibung Hardware-Schnittstellen: Tastatur, Monitor, serielle/parallele Schnittstellen, IR-Schnittstellen, Diskettenlaufwerk, Ethernet, etc.

  • Betriebssystem

  • Multitasking Betrieb

Hinweis, wo diese Angaben im Gerätehandbuch zu finden sind



Hier sollte klar herausgestellt werden, warum es sich um ein gekapseltes System handelt. Es ist deutlich aufzuzeigen, dass dem Benutzer nur die vorgegebenen Funktionen zur Verfügung stehen und er keine Möglichkeit hat, diese zu erweitern. Ein Blockschaltbild des Systemaufbaus ist beizufügen.

2.2 Software läuft auf einem PC-System (universal computer)


  • wesentliche Hardware-Komponenten (Prozessor, Speicher, Festplatte, etc.)

  • Beschreibung der Hardware-Schnittstellen: (Tastatur, Monitor, serielle/parallele Schnittstellen, Diskette, CD, Ethernet, etc.)

  • Betriebssystem

  • Multitasking Betrieb

Verweis, wo diese Angaben im Gerätehandbuch zu finden sind



Bei Systemen, die vom Aufbau her nicht einem handelsüblichen PC entsprechen, aber auf PC-Technologie basieren, ist eine erweiterte Systembeschreibung und ein Blockschaltbild beizufügen.


2.3 Anzahl und Typ der anschließbaren Waagen


  • Welche Waagentypen dürfen angeschlossen werden?
    EG-Zulassung, Hersteller, Typ, eventuelle Besonderheiten

  • Phys. Anschluss der Waagen, Verplombung der Anschlüsse

  • Datenprotokolle / Datentransfer

  • Datensicherheit des Protokolls


2.4 Anschließbare Zusatzeinrichtungen


  • Hersteller, Typ

  • Eigenschaften, Funktionen

  • Einstellungen


2.5 Verbindung zu Netzwerk, Server, o.ä.


  • Austausch welcher Daten?

  • Datenprotokoll

  • Datensicherheit des Protokolls

Eine genaue Beschreibung der Kommunikationsprotokolle; welche Daten werden zu welchem Zweck übertragen? Wodurch wird die Datensicherheit gewährleistet?


2.6 Sonstige Hardware-Komponenten




3.Funktionalität und Bedienung der Software:

3.1 Vollständige Beschreibung der Funktionalität der Software:


Die Funktionalität der an der PTB vorgestellten Software sollte vollständig sein und alle eichpflichtigen und nicht eichpflichtigen Programmteile umfassen.

3.1.1 Eichpflichtige Funktionen der Software

z.B.: eichpflichtige Speicherung von Wägeergebnissen auf der Festplatte,

Darstellung der Wägeergebnisse auf einem Display als Haupt- oder Zweitanzeige,

Realisierung eines Logbuchs,

eichpflichtiger Abdruck der Wägeergebnisse,

Editierung des Ausdrucks,

Software-Download (s.a. Kapitel 6),

Programmierung eichpflichtiger Funktionen.

3.1.2 Nicht eichpflichtige Funktionen der vorgestellten Software

Beschreibung der Funktionen und Applikationen, die nicht der Eichpflicht unterliegen

3.2 Bedienung der Software:


Vollständige Beschreibung der Bedienung der vorgestellten Software, inkl. der Bedienung der nicht eichpflichtigen Programmteile. Vorlage des Bedienerhandbuchs für die Software.


3.3 Programmierbarkeit der Software


3.3.1 Beschreibung der Programmiermöglichkeiten der Software

      1. vollständige Beschreibung der für den Anwender verfügbaren Befehle
        Vorlage des Bedienerhandbuchs für die Software

Hier sollte darauf hingewiesen werden, ob nur der Hersteller oder auch der Bediener Möglichkeiten zur Änderung / Ergänzung der Software hat. Dies könnte z.B. das Ändern des Drucklayouts oder der Größe und Form der Anzeige sein (nur nichteichpflichtig).


3.4 Benutzeroberfläche geschlossen


3.4.1 Automatisches Booten der Programm-Module (PM) ja / nein

      1. Anwender hat keinen Zugang zum Betriebssystem ja / nein

      2. Anwender hat nur Zugang zu zugelassenen Programmen ja / nein

      3. Vollständiger Befehlssatz mit kurzen Erläuterungen liegt vor ja / nein

      4. Schriftliche Erklärung der Vollständigkeit liegt vor ja / nein

Es ist darzulegen, wie die einzelnen Punkte umgesetzt sind.

3.5. Benutzeroberfläche nicht geschlossen


Welche weitere Software (Word, Excel, weitere Applikationen etc.) darf betrieben werden?

3.5.1 Beschreibung der für den Anwender frei verfügbaren Befehle



      1. Welche Sicherungsmaßnahmen gegen Manipulation der Software sind realisiert?
        (kurze Auflistung, genaue Beschreibung in Kapitel 5)

      1. Vollständiger Befehlssatz mit kurzen Erläuterungen liegt vor ja / nein

      2. Schriftliche Erklärung der Vollständigkeit liegt vor ja / nein

Es ist darzulegen, wie die einzelnen Punkte umgesetzt sind.

4.Struktur der Software

4.1 Trennung zwischen eichpflichtigen und nicht eichpflichtigen Programm- Modulen


      1. Liste mit der Bezeichnung der eichpflichtigen Programm-Module

      2. Eichpflichtige Programm-Module liegen als ausführbarer Code (*.exe), (*.dll) etc vor

      3. Programm-Module sind wo gespeichert?

      4. Beschreibung der Aufgaben / integrierten Funktionen der Programm-Module

      5. Bezeichnung / Beschreibung der nicht eichpflichtigen Programm-Module (Applikation)

Aus den Beschreibungen sollte deutlich werden, wie die Trennung der Module realisiert ist.


4.2 Keine Trennung zwischen eichpflichtigen und nicht eichpflichtigen Programm- Modulen


      1. Liste mit der Bezeichnung der Programm-Module der Software und deren Funktionen

      2. Beschreibung der Funktionalität der Programm-Module

      3. eichpflichtige Programm-Module liegen als ausführbarer Code (*.exe), (*.dll) vor

      4. Programm-Module sind wo gespeichert?



4.3 Eichfähige Software-Module auf mehrere Systeme verteilt


      1. Liste mit der Bezeichnung der Module, deren Funktionen und Ausführungsort

      2. Beschreibung zusätzlicher Sicherheitsmechanismen zur Kommunikation zwischen den Systemen

      3. Datenprotokolle

      4. Identifikation der verteilten Softwaremodule


4.4 Beschreibung der Software-Schnittstellen


      1. Schnittstelle zwischen eichpflichtigen und nicht eichpflichtigen Funktionen
        eichpfl. Funktionen  nicht eichpfl. Applikation:

Input: z.B. Aufruf zum Wägen

Output: z.B. Wägeergebnis



      1. Schnittstelle zwischen eichpfl. Funktionen und Hardware:
        z.B. eichpfl. Funktionen  serielle Schnittstelle:
        Input: z.B. Aufruf zum Wägen
        Output: z.B. Wägeergebnis

      2. Vollständige Liste aller Schnittstellenbefehle zu 4.4.1 und 4.4.2

      3. Schriftliche Erklärung der Vollständigkeit der Listen zu 4.4.3 muss vorliegen

      4. Schriftliche Erklärung der Rückwirkungsfreiheit zu 4.4.1 und 4.4.2 muss vorliegen

4.5 Gerätespezifische Parameter (GP)

4.5.1 Auf welche GP greift die Software zu (Auflistung/Beschreibung)?

4.5.2 Bietet die Software die Möglichkeit, GP zu generieren oder zu verändern?

4.5.3 Wie sind die GP gespeichert (Softwaremodul / Datei / Speichermedium / Format)?



Die GP beinhalten die Justierparameter, Max, Min, e,d, Masseeinheiten

4.6 Typspezifische Parameter (TP)


4.6.1 Auf welche TP greift die Software zu (Auflistung/Beschreibung)

4.6.2 Bietet die Software die Möglichkeit, TP zu generieren oder zu verändern?

4.6.3 Wie sind die TP gespeichert (Softwaremodul / Datei / Speichermedium /Format)

Die TP beinhalten z.B. die Parameter für die Stabilitätsanalyse, Rundung und
Gewichtsermittlung


4.7 Variable Werte (VW)


4.7.1 Bietet die Software die Möglichkeit, VW zu generieren und zu speichern?
(Auflistung der VW)

4.7.2 Welche VW können mit der Software ausgelesen werden?


(Auflistung/Beschreibung)

Die VW beinhalten z.B. Messdaten, Einträge in eichpfl. Datenspeicher, Tara

4.8 Low-Level-Treiber


      1. In welchen Anwendungen kommen Low-Level-Treiber zum Einsatz?

      2. Auflistung der verwendeten Low-Level-Treiber

      3. Handelt es sich um Treiber, die standardmäßig zum Betriebsystem gehören?



    1. Grafische Darstellung der Module, Funktionen und Schnittstellen

Module, Funktionen, Software- und Hardware-Schnittstellen sind in einer Grafik zu bezeichnen oder zu nummerieren. Darstellung des Zugriffs auf gerätespezifische / typspezifische Parameter und variable Werte.

Die Darstellung sollte mittels eines einfachen Blockschaltbilds erfolgen. In diesem sind die Richtungen sämtlicher Kommunikationswege darzustellen.

5.Sicherungsmaßnahmen für Software und Parameter

5.1 Hardwaretechnische Sicherung der Software


Beschreibung des Sicherungsverfahrens; z.B. Dongel, nicht überschreibbares Speichermedium, Hardware-Plombe


5.2 Manipulationen des Programm-Codes


      1. Beschreibung des Sicherungsverfahrens

      2. Verhalten des Programms bei manipuliertem Programm-Code

      3. Besonderheiten

Hier sollte detailliert auf das Sicherungsverfahren eingegangen werden. Beispielsweise, mit welchem Algorithmus eine Checksumme oder Signatur über den Programmcode gebildet wird.

5.3 Funktionale Prüfzahl


      1. Bildung der Prüfzahl

      2. Beteiligte eichpflichtige Funktionen / Module an der Bestimmung der funkt. Prüfzahl und deren Ident-Code

      3. Verhalten des Programms bei manipuliertem Programm-Code

      4. Der Applikationsprogrammierer wird darauf hingewiesen, dass es sich um ein eichpflichtiges Modul / eine eichpflichtige Funktion handelt, deren funktionale Änderungen zu einer Änderung der ID-Nummer führen. Ein entsprechender Hinweis im Quellcode ist notwendig.

      5. Angabe der Prüfzahl und Beschreibung der Kontrollfunktion

      6. Besonderheiten

Sollte statt der funktionalen Prüfzahl eine echte Checksumme oder Signatur benutzt werden, so sind die Kapitel 5.3.1 bis 5.3.6 dennoch (entsprechend abgeändert) zu dokumentieren.

5.4 Sicherung gerätespezifischer Parameter


      1. Speichermedium / Speicherort

      2. Maßnahmen gegen absichtliche / unabsichtliche Veränderung
        z.B. Checksumme über GP, Hardwaresicherung

      3. Verhalten des Programms bei manipulierten gerätespez. Parametern

      4. Beschreibung der Kontrolleinrichtungen zum Schutz gegen Veränderungen
        z.B. Ereigniszähler, Logbuch


5.5 Sicherung typspezifischer Parameter


      1. Speichermedium / Speicherort; z.B. Waage

      2. Sicherungsmechanismen gegen absichtliche / unabsichtliche Veränderung
        z.B. Checksumme über TP, Hardware-Sicherung

      3. Verhalten des Programms bei manipulierten typspezifischen Parametern

      4. Beschreibung der Kontrolleinrichtungen zum Schutz gegen Veränderungen, z.B. Ereigniszähler, Logbuch


5.6 Sicherung der variablen Werte


      1. Speichermedium / Speicherort

      2. Sicherungsmechanismen gegen absichtliche / unabsichtliche Veränderung
        z.B. Checksumme über VW, Hardware-Sicherung

      3. Verhalten des Programms bei manipulierten variablen Parametern

      4. Beschreibung der Kontrolleinrichtungen zum Schutz gegen Veränderungen
        z.B. Ereigniszähler, Logbuch



    1. Kontrollfunktionen


5.7.1 Es müssen Kontrolleinrichtungen (z.B. Ereigniszähler, Logbuch) existieren für

die Programmmodule

die GP

die TP


die VW



      1. Checksummen müssen generiert werden über

der Programmmodule

der GP


der TP

der VW




      1. Das Verfahren zur Ermittlung der Prüfzahl über den Programmcode muss beschrieben werden


6.Software-Download

6.1 Software-Download ist nicht vorgesehen


Bei der Software handelt es sich lediglich um Software für eine einfache Zusatzeinrichtung, besondere Schutzmaßnahmen für Software-Download sind nicht erforderlich

Wenn es sich um eine einfache Zusatzeinrichtung handelt (z.B. nichtpreisrechnendes Kassensystem oder Alibidrucker), müssen die erweiterten Anforderungen bezüglich des Softwaredownloads, z.B. Zusatzhardware, nicht angewendet werden.

6.2 Softwaredownload bei Zusatzeinrichtungen

      1. Welche Schutzmaßnahmen gegen Software-Download existieren
        z.B. Hardware-Sicherung, keine geeigneten Schnittstellen vorhanden, etc.)

Wenn ein Softwaredownload nicht vorgesehen ist, darf ein Download auch für den Hersteller (nach In-Verkehr-Bringen) nicht möglich sein. Es ist zu beschreiben, mit welchen Mitteln dies verhindert wird.


6.3 Software-Download ist nur für nicht eichpflichtige Programmteile vorgesehen


      1. Beschreibung des Download-Verfahrens

      2. Wie ist die eichpflichtige Software gegen Software-Download gesichert?

      3. Eine Bescheinigung des Herstellers, dass mit den nicht-eichpflichtigen Softwareteilen keine neuen, eichpflichtigen Funktionen importiert werden, liegt vor ja / nein

Kapitel 6.3 kann nur bei Trennung von eichpflichtiger und nicht eichpflichtiger Software angewendet werden. Die Trennung ist unter Kapitel 4 zu beschreiben.

6.4 Software-Download für eichpflichtige Programmteile

Dieses Kapitel ist für eichpflichtige und nicht eichpflichtige Programmteile anzuwenden, falls keine Softwaretrennung existiert.



      1. Beschreibung des Download-Verfahrens

      2. Wie ist sichergestellt, dass nur zugelassene Software geladen wird?
        Überprüfung der Software-Identifikation, überprüfende Software muss hardwaretechnisch gesichert sein, Beschreibung der Sicherungsverfahren (WELMEC 2.3, Anforderung B1)

      3. Wie erfolgt die Überprüfung der Authentizität und Integrität der geladenen Software? Besteht eine automatische Prüffunktion im festen Softwareteil?
        Beschreibung des Verfahrens (WELMEC 2.3, Anforderung B2)

      4. Wie ist sichergestellt, dass mit geeigneten Mitteln das Laden von Software bei späteren Kontrollen rückverfolgt werden kann? (WELMEC 2.3 Anf. B3)
        Beschreibung des Logbuchs. Verhalten bei Erreichen der Grenze der Logbuch-Kapazität. Könnten Daten aus dem Logbuch gelöscht werden? Wie ist das Logbuch vor Manipulationen geschützt?

      5. Wie ist sichergestellt, dass die Software nur mit der ausdrücklichen Zustimmung durch den Verwender des Messgerätes geladen werden kann? (WELMEC 2.3, Anforderung B4)

Das Verfahren zum Download ist genau zu beschreiben und mittels Blockschaltbild darzustellen. Beispielhafte Darstellung siehe WELMEC-Guide 2.3, Anhang 3.


6.5 Checkliste Software-Download


6.5.1 Anforderungen an Software-Download müssen nicht eingehalten werden, da es sich um eine Zusatzeinrichtung handelt ja / nein

6.5.2 Software-Download nicht vorgesehen ja / nein

6.5.3 Software-Download von nicht eichpflichtigen Programmteilen ja / nein

Eichpflichtige Programmteile sind gegen Software-Download


gesichert? ja / nein

Schnittstelle zwischen eichpflichtiger und nicht eichpflichtiger


Software ist rückwirkungsfrei? ja / nein

Software-Download ohne Zustimmung des Verwenders nicht


möglich? ja / nein
Eine Bescheinigung des Herstellers, dass mit den nicht-
eichpflichtigen Softwareteilen keine neuen, eichpflichtigen
Funktionen importiert werden, liegt vor. ja / nein

      1. Software-Download von eichpflichtigen Programmteilen ja / nein
        Überprüfung der Software-Identifikation durch besonders
        gesicherte Software ja / nein
        Überprüfung der Identifikation vor Aufspielen der Software ja / nein
        Überprüfung der Software-Authentizität durch besonders
        gesicherte Software ja / nein
        Überprüfung der Authentizität vor Aufspielen der Software ja / nein
        Überprüfung der Software-Integrität durch besonders
        gesicherte Software ja / nein
        Überprüfung der Integrität vor Aufspielen der Software ja / nein
        Es ist sichergestellt, dass nur zugelassene Software
        heruntergeladen werden kann ja / nein
        Es ist sichergestellt, dass ein Software-Download nur mit
        ausdrücklicher Zustimmung des Verwenders durchgeführt
        werden kann ja / nein

      2. Es existiert ein Logbuch ja / nein
        Die Einträge im Logbuch sind vollständig und ausreichend
        zur Rückverfolgung der Download-Vorgänge ja / nein

Das Logbuch ist ausreichend gegen Manipulationen
gesichert ja / nein
Die Speicherkapazität des Logbuchs ist ausreichend ja / nein
Ist die Speichergrenze des Logbuchs erreicht, sind keine
weiteren Software-Downloads möglich ja / nein

      1. Es existiert ein Ereigniszähler ja / nein
        Ein Zurücksetzen des Ereigniszählers ohne Verletzung einer
        Hardware-Sicherung ist nicht möglich ja / nein

      2. Schriftliche Erklärung der Richtigkeit und Vollständigkeit
        liegt vor ja / nein



7.Informationen zur Eichung



7.1 Sicherungs- und Stempelstellen
Anbringungsort

Beschreibung, Abbildungen



7.2 Kennzeichungsschild


Bild des Kennzeichnungsschildes; Darstellung des Anbringungsortes


7.3 Angaben zur Software auf dem Kennzeichungsschild:


Versionsnummer der Software

Beschreibung der Nomenklatur (fester Teil der Versions-Nr., variabler Teil)

Checksumme / Funktionale Prüfzahl

Ereigniszähler



7.4 Anweisungen zur Eichung:


Auslesen der Versions-Nummer

Auslesen der Checksumme / Funktionalen Prüfzahl

Auslesen des Ereigniszählers

Überprüfung des Logbuchs

Überprüfung sonstiger Kontrolleinrichtungen
Es ist eine ausführliche Beschreibung zu erstellen, wie die einzelnen Informationen abzurufen sind. Hilfreich sind hier Screenshots.

8.Erforderliche schriftliche Erklärungen



- Erklärung, dass die frei programmierbare Einrichtung einschließlich ihrer Software der Norm EN45501 entspricht.

- Erklärung, dass die Liste der dokumentierten Module, Funktionen und Prozeduren vollständig ist.



- Erklärung, dass die Liste der dokumentierten Schnittstellen vollständig ist und sämtliche Schnittstellen rückwirkungsfrei im Sinne der Norm EN45501 (5.3.6.1) sind.

- Bescheinigung des Herstellers, dass mit nicht-eichpflichtigen Softwareteilen keine neuen, eichpflichtigen Funktionen importiert oder realisiert werden.


Dostları ilə paylaş:


Verilənlər bazası müəlliflik hüququ ilə müdafiə olunur ©genderi.org 2019
rəhbərliyinə müraciət

    Ana səhifə