Diskussion:Softwaredokumentation

Interessant es hat mir geholfen.V Dank

Überarbeitung

Moin allerseits,

der Artikel sollte weiter überarbeitet werden: Es fehlen noch einige Absätze zu Design Dokumentation usw.

Außerdem muss man die Struktur des Artikel ansich nochmals überarbeiten, da die so auch nicht bleiben kann. Ich werd mich evtl. die Tage mal drum kümmern (kann aber nichts garantieren ;) )

gruß --FutureCrash 04:30, 2. Jan 2006 (CET)

Englische Seite als Vorbild?

Vielleicht könnte man die englische Seite dafür als Vorbild nehmen: http://en.wikipedia.org/wiki/Software_documentation

Softwaredokumentation verpflichtend?

Ist es einem Softwareproduzenten in Deutschland gesetzlich vorgeschrieben, eine vernünftige, vollständige (Benutzer-)Dokumentation zu einer Software anzufertigen? Bei technischen Geräten ist es m.E. Pflicht. --Abdull 23:09, 25. Jan. 2007 (CET)

Dies lässt sich nur indierekt beantworten mit der Aussage das man state of the art Entwickeln muss, also nach aktuellem standart. Das Aktuelle übliche verfahren ist software vollständig zu dokumentieren , dies hilft auch evtl spätere versäumnisse zu dokumentieren oder schuld fragen zu klären, ohne dokumentation ist dies sonst sehr schwierig (nicht signierter Beitrag von 193.1.40.28 (Diskussion | Beiträge) 14:21, 17. Feb. 2010 (CET))

Zu dieser Frage kann ein Zitat nach Beckmann Antwort geben:
„Nach der Rechtsprechung des BGH zum Thema "EDV-Anwenderdokumentationen" ist es als geklärt anzusehen, dass, unabhängig vom in Frage kommenden Vertragstyp, die Softwareüberlassung neben der Überlassung des Programms auch zur Überlassung entsprechender Programminformationen verpflichtet. Dabei ist zu beachten, daß es sich nicht nur um eine im Neben- sondern vielmehr um eine im Gegenseitigkeitsverhältnis stehende Hauptleistungspflicht des Lieferanten handelt, und zwar sowohl bei Standard- als auch bei Individualsoftware.“
Weiteres siehe http://www.finanztip.de/recht/wirtschaftsrecht/edv12.htm.
Siehe hierzu auch die Diskussion im Artikel Software.
--VÖRBY 10:49, 9. Feb. 2011 (CET), aktuell: --VÖRBY 13:17, 9. Feb. 2011 (CET)

Literatur

Liste der Literatur muss erweitert werden. Nur ein Buch aus Jahr 1994 - das ist zu wenig (nicht signierter Beitrag von Hellboy81 (Diskussion | Beiträge) 21:55, 1. Jul 2013 (CEST))

Immer sachte. Die drei DIN gehören auch noch dazu; und der inhaltliche Bereich ist seit der Papier-Zeit nicht ungültig geworden.

Was hinzugekommen ist, sind die Online-verfügbaren Darstellungsformate. Hier werden sich passenderweise eher Weblinks als gedrucktes Papier finden.

VG --PerfektesChaos 21:11, 20. Jul. 2013 (CEST)

it's not a bug - it's a feature!

...ja, da schmunzelt man heut noch drüber, über diesen running EDV-gag aus den neunzigern ;) .

aber da war oft auch wat wahres dran: denn für viele anwendungsprogrammierer wars nix anderes als ein zugeständnis an die user(insbesondere im öffentlichen dienst). die wollten so manches in "ihrem" programm haben, selbst wenn der sinn nich einleuchtete und dat ganze sogar widersprüchlich war. aba diejenigen waren oft einige gehaltsstufen höher und konnten einem das leben schon schwer machen :( ...

was ich nun vermisse, iss dieser (inzwischen wohl veraltete) englische fachausdruck für die softwareentwicklungs-kurzdokumentation, damals so ein gängiges kunstwort wie HowTo. unter vielen neuen versionen fand man diese kurzfassungen der jeweiligen programmierer - etwa nach dem schema

datum | (evtll. neue versionsnr.) | und dann eine äusserst kurz gefasste beschreibung aller veränderungen (nich nur der bugfixes!). sozusagen die versionskurzgeschichte der programmierung in listenform und gleichzeitig auch sowas wie ein kurzer arbeitsbericht.

im wesentlichen also für andere programmierer "nach aussen gerichtet"(wie im lemma Softwaredokumentation angedeutet). wenn ich mich nich irre, wars auch eine Initialenabkürzung, ähnlich wie FAQ. leider kommich einfach nich mehr auf den namen, sorry...

lg, --91.10.8.89 23:07, 14. Feb. 2013 (CET)

Einen definitiven und weit verbreiteten Fachausdruck als Drei-Buchstaben-Abkürzung kenne ich nicht; also behaupte ich keck, dass dies eher spezifisch für Tool oder Community wäre.

• Übliche Begriffe wären spezifisch: log message oder release comment (scherzhaft wohl auch commit comment) oder schlicht allgemein summary oder abstract (selten subject; das wäre E-Mail). Thematisch handelt es sich bei dem Eintrag um einen commit, wenn es ein Beitrag von innen wäre; mitunter auch ungenauer version oder revision, weil nach außen das Gesamtpaket betreffend; dort präzise das von dir Beschriebene als release notes (2 Buchstaben). In der deutschsprachigen Wikipedia heißt das BK oder Z+Q, in englischsprachigen Wikis edit summary.
• Der Typus ist one-liner. Offenbar brief.
• Intern gibt es den Stempel „RTM – Release To Manufacturing“.
• Eine Drei-Buchstaben-Abkürzung ohne eine Definition oder präzise inhaltliche Erklärung wäre „VFN – Vendor Feature Note“ (weil in der Abschnittsüberschrift „feature“ erwähnt); kein Standard-Ausdruck.
• Vielleicht helfen diese Schlüsselwörter deiner Erinnerung, die Abkürzung oder den Begriff zusammzubasteln.

swe --PerfektesChaos 10:21, 15. Feb. 2013 (CET)

... vielen dank für die promte antwort, PC ;) !

ich hab mich vielleicht zu sehr auf diese drei buchstaben versteift - es könnten auch mehr gewesen sein. wurde auch im VMS von Digital-mitarbeitern verwendet.

nein, bis jezz isses mich noch nich wieder eingefallen. aba ich werd schon noch drauf kommen!

lg, --Najadenn (Diskussion) 15:49, 15. Feb. 2013 (CET)

Warum ...

steht solcher Unsinn in einer Enzyklopädie: "„Nach der Rechtsprechung des BGH zum Thema ‚EDV-Anwenderdokumentationen‘ ist es als geklärt anzusehen, dass, unabhängig vom in Frage kommenden Vertragstyp, die Softwareüberlassung neben der Überlassung des Programms auch zur Überlassung entsprechender Programminformationen verpflichtet." Das zeigt nur eines: Die absolute Laienhaftigkeit des BGH und einiger weiterer Juristen im Bereich Informatik, ja selbst auf juristischem Gebiete, denn die heute üblichen und massenhaft verwendeten Lizenzen können derlei Dinge sehr wohl von vornherein fakultativ stellen, wenn nicht gänzlich ausschließen und genau dies geschieht ja (leider) auch - weltweit. Letzteres ist z.B. bei proprietärem Code die Regel. Es kann einem schon Himmelangst werden, ein "Höchstgericht" (lol) derart dilettantisch agieren zu sehen, aber daß sich diesen offensichtlich unausgegorenen Unsinn (von einer "gesicherten Rechtsprechung kann in diesem Fall von vornherein keine Rede sein, dazu sind schon die Fallzahlen (und die Expertise der Entscheider um Größenordnungen!) viel zu klein, insofern überschreitet auch der Kommentar seine Grenzen und versucht, Zünglein an der Waage zu spielen, indem er etwas festzuzurren sucht, was dafür völlig ungeeignet ist) ) auch noch eine weltweit verfügbare Enzyklopädie kommentarlos zu eigen macht, läßt darauf schließen, daß hier wie da Kräfte am Werk sind, die der Menschheit Sand ins Getriebe zu streuen suchen. Darüberhinaus wird sichtbar, daß mit dem heute immer noch üblichen juristischen Denken in Kategorien und Begrifflichkeiten des überkommenen römischen Rechtes die Herausforderungen der moderne in keinster Weise angemessen und sinnvoll gemeistert und Probleme sinnvoll gelöst werden können, ohne daß sich das System dabei selbst in Frage stellt - und letztlich: Abschafft. Insofern möchte ich anregen, die Gesamtkonzeption des Artikels neu zu durchdenken, zumindest aber den mißratenen "juristischen" Abschnitt zu streichen - er ist weder für die IT-Branche, noch für die Juristerei ein Ruhmesblatt, geschweigedenn juristisch belastbar und in einem auf Einzelfallrecht abstellenden System darüberhinaus praktisch irrelevant - zumal der BGH dabei völlig das internationale Wesen von Software verkannt und schon deshalb puren, mehr als peinlichen Blödsinn produziert hat, der sich im internationalen Rechtsverkehr in keinster Weise realisieren läßt. (Beispiel: In wievielen Sprachen (und welchen) muß denn eine standardisierte Dokumentation beigegeben werden? ;-) Ist das von einem Programmierer überhaupt leistbar?? Sind Computerprogramme nach den Gesetzen der Logik nicht sowieso von vornherein selbsterklärend? Wie will man denn die Grenzen der Dokumentation, den Grad der Dokumentation juristisch verbindlich fassen??? (Vor allem vor dem Hintergrunde, daß es im IT Bereich den in der veralteten Juristerei häufig strapazierten "verständigen Nutzer" nicht gibt, ja: vielfach von vornherein nicht geben kann. Gäbe es ihn, wozu dann noch Dokumentation?? Welche Form der Dokumentation kann Komplexität höheren Grades auflösen?? Folgte man der Logik des BGH, dann bräuchte es in hochkomplexen Fällen von software dann auch noch eine "Dokumentation der Dokumentation", - wo wären da die Grenze zu ziehen? etc. pp. Das Urteil ist lediglich "Arbeitsbeschaffungsmaßnahme für Juristen" - sachlich aber ziemlich unsinnig, wie sich mit Sicherheit noch zeigen wird. Von den Kollisionen zwischen Dokumentationspflicht und Betriebsgeheimnissen (v.a. bei proprietärer Software) garnicht zu reden ... Usw. usf. D.h.: Das BGH-Urteil ist reines Einzelfallurteil und in keinster Weise verallgemeinerbar - diesbezüglich irrt selbst der ansonsten von mir überwiegend hochgeschätzte Kommentar ... eine Enzyklopädie aber sollte VORHER auf sachliche Relevanz prüfen und ggf. sich aus unabgeschlossenen Entwicklungen des Zeitgeschehens vornehm heraushalten, sie jedenfalls nicht voreilig und irreführend als "Abgeschlossen" darstellen. Das ist enzyklopädiemethodisch unterste Schublade und sollte in der wikipedia nicht mehr vorkommen, wenn sie nicht in den Ruf einer Anfänger- und Laienveranstaltung kommen will. Auch ist ein juristischer Abschnitt für die Erklärung des Begriffes "Softwaredokumentation" sachlich von vornherein nicht zwingend erforderlich - warum dann also diese (durchaus vermeidbare) Peinlichkeit? Soll der Artikel nur den BGH vorführen?? Das sind doch auch nur Menschen und können sich mal gründlich irren. Ist ja auch nicht das erste mal ... Hella

Bin kein Jurist, denke aber, dass die Vorgabe, eine Dokumentation mitzuliefern, schon irgendwie mehr als berechtigt ist - und kein 'Unsinn', zumal dort auf die valide Quelle 'Beck' verwiesen wird. Mit der Formulierung "entsprechende Programminformationen" ist schließlich nicht festgelegt, was das genau und im Einzelfall sein muss. Also: Das Kind bitte nicht mit dem Bad ausschütten, eine Dokumentation gehört zur Software und entsprechende Aussagen in die Wikipedia. Man könnte diese Aussagen sicher etwas konkreter fassen - was wahrscheinlich an verschiedenen Stellen auch schon geschehen ist, und wenn 'nur' in Urteilen. Verbesserungen/Ergänzungen sind in WP immer möglich und willkommen.--VÖRBY (Diskussion) 10:54, 7. Jan. 2018 (CET)

Artikel ist völlig veraltet

Es werden nur 2 Quellhinweise angegeben. Einer ist aus dem Jahr 1998 (22 Jahre alt!!), der zweite ohne Jahresangabe. Der Literaturverweis zeigt auf ein Buch aus dem Jahr 1994. Aktuelle Normen, neuere Literatur oder Urteile aus dem 21. Jahrhundert sind komplett ignoriert. Bitte Artikel sperren oder entsorgen - das ist ein Unding. (nicht signierter Beitrag von 188.105.87.174 (Diskussion) 15:07, 18. Apr. 2021 (CEST))

Du wirst lachen, aber die Sachverhalte sind unverändert aktuell und am Grundprinzip hat sich im letzten Vierteljahrhundert nichts geändert.

• Nur die Publikationsform und die Aktualität der Dokus ist durch elektronische Formate und Online-Dokumente beschleunigt worden; und Online-Updates der Software gehen halt mit hoffentlich konsistenter Doku einher. Das ist jedoch umseitig längst erwähnt.
• Weder an der Zielgruppenorientierung noch sonstwodran hat sich irgendwas verändert. „Veraltet“ ist da überhaupt nichts. Bruchrechnung ging vor 100 Jahren auch nicht anders.
• „Urteile“ sind überhaupt nicht das Thema; es geht primär um den technischen Aspekt, die Juristerei hat mal wer als Fremdkörper eingebracht, wobei deren Wortwahl auch wieder nicht zu den Sitten der technischen Welt passt.

Es steht dir aber frei, das Netz zu durchgrabbeln nach reputablen deutschsprachigen Weblinks, und diese dann umseitig zu ergänzen.

• https://www.softguide.de/software-tipps/softwaredokumentation wäre ein gekürzter Klon von umseitig.
• Etwas googlen wird dir zeigen, dass sehr viele Firmen Webseiten zum Thema allgemein erstellt haben, die just den umseitigen und seit 2004/2010 bestehenden Textkorpus als Grundlage verwenden und für ihre Zwecke angepasst haben.

VG --PerfektesChaos 21:40, 18. Apr. 2021 (CEST)