Softwaredokumentation

ANZEIGE
ANZEIGE
  • Hallo SiFas,

    hat jemand Erfahrungen und Infos, welche Dokumentation bei einer Software mitgeliefert werden muss?

    Ist das vergleichbar mit der Bedienungsanleitung für Maschinen und Anlagen?
    Welche Sprache ist ggf. gefordert (-> CE: Sprache des Landes, in dem die Maschine in Verkehr gebracht wird)?

    Gruß, Niko.

    - Bei Gefahr im Verzug ist körperliche Abwesenheit besser als Geistesgegenwart -

  • ANZEIGE
    • Offizieller Beitrag

    Hallo Niko,

    hab mal zur begriffdefinition folgenden artikel in wikipedia gefunden.

    Da kommt es doch darauf an welche software du benötigst und in welcher sprache diese angeboten wird.

    Ich denke, dass es nicht vergleichbar ist wie mit Maschinen und Anlagen.

    Alle sagten: Es geht nicht. Da kam einer, der das nicht wusste und tat es einfach.(Goran Kikic)

    Wer nichts weiß, muß alles glauben. (Marie von Ebner-Eschenbach)
    „Habe Mut, dich deines eigenen Verstandes zu bedienen!“
    (Sapere aude)

  • Hallo Toni,

    zur Präzisierung:
    Ich lasse derzeit von einem Programmierhaus eine Software zur Durchführung von Gefährdungsbeurteilungen programmieren.
    Das Programm wird klasse, da es genau auf unsere Anforderungen zugeschnitten wird.

    Im Pflichtenheft sind die technischen und inhaltlichen Anforderungen an die Software festgelegt. Leider jedoch keine Details zur Dokumentation.
    Deswegen die Frage: Was kann ich an Dokumentation (Bedienerhandbuch, Fehlerbeschreibung,...) erwarten? Was ist marktüblich? Was ist Minimum?

    Gruß, Niko.

    - Bei Gefahr im Verzug ist körperliche Abwesenheit besser als Geistesgegenwart -

    • Offizieller Beitrag

    Hallo Niko,

    im Pfichtenheft sollte drin stehen ob ein Benutzerhandbuch Bestandteil der gekauften Software ist oder nicht.

    Ich kann allerdings nicht beurteilen, ob die Programierer auf ein bestehende Software weiter aufbaut oder ob sie komplett etwas neues schreiben.
    Wenn das Programm auf eine Software aufbaut dann solltest Du fragen auf welcher um im Vorfeld eventuell was zu haben.

    Zitat Wikipedia:

    Zitat

    Das Pflichtenheft wird vom Auftragnehmer formuliert und auf dessen Wunsch vom Auftraggeber bestätigt. Idealerweise sollten erst nach dieser Bestätigung die eigentlichen Entwicklungs-/Implementierungsarbeiten beginnen. Der Auftragnehmer hat einen durch den Vertrag bestimmten Anspruch auf solche Bestätigung (Mitwirkungspflicht nach §643 BGB). Es ist bewährte Praxis, bei der Erstellung eines Pflichtenheftes das Ein- und Ausschlussprinzip zu verwenden, d. h., konkrete Fälle explizit ein- oder auszuschließen. Bei Lieferung wird formell eine Abnahme vollzogen, die die Ausführung des Werkvertrages oder auch des Kaufvertrages beschließt

  • Hallo Toni,

    die Software wird komplett neu programmiert auf Basis der JRubyOnRails-Sprache.

    Und das Pflichtenheft habe ich selber geschrieben :22:
    Da steht zwar viel über Dokumentation drin. Aber nur über die Dokumentation, Archivierung und Nachverfolgbarkeit von Gefährdungsbeurteilungen und leider nicht der Software selbst. Mein Fehler...

    Und unsere IT hält sich raus, da es eine extern eingekaufte Software ist, die nicht von IT betreut wird.
    Und um die Frage vorweg zu nehmen, mit IT-Beteiligung wäre das Projekt in unserem Hause bereits letztes Jahr gescheitert.

    Mit dem Softwarehaus haben wir inhaltlich hervorragende Erfahrungen gemacht. Das entwickelte Chemikalieninformationssystem hat z.B. schon seit letzten Sommer die GHS-Klassifizierungen implementiert und wird wohl dieses Jahr noch weltweit auf alle Standorte ausgerollt.
    Nur sind eben die guten Programmierer nicht diejenigen, die sich hinsetzen und ein Bedienerhandbuch schreiben... Würde sie selber ja auch in gewisser Weise überflüssig machen.

    Gruß, Niko.

    - Bei Gefahr im Verzug ist körperliche Abwesenheit besser als Geistesgegenwart -

  • ANZEIGE
    • Offizieller Beitrag

    Hmmmmmm,

    jetzt wird es kompliziert 8o 8o 8o

    Wenn Du an der Entwicklung (vorgabe wie es werden soll) der Software beteiligt bist und Du das Benutzerhandbuch nicht mit beauftragt hast, solltest Du schnell hilfe suchen.

    So ein Benutzerhandbuch kann sehr kompliziert werden, da hast Du nur noch zwei Alternativen:

    Entweder selber machen oder zusätzlich beauftragen......

    Alle sagten: Es geht nicht. Da kam einer, der das nicht wusste und tat es einfach.(Goran Kikic)

    Wer nichts weiß, muß alles glauben. (Marie von Ebner-Eschenbach)
    „Habe Mut, dich deines eigenen Verstandes zu bedienen!“
    (Sapere aude)