Der folgende Beitrag wurde am 19. 02. 2009, 15:19 Uhr von K.Bokov veröffentlicht.
Hallo Leute,
ich möchte gerne eine ausführliche Dokumentation für den firmeninternen Gebrauch von Software mitführen, nun habe ich damit zu wenig Erfahrung.
Welche Dateien gibt es und was man dorthin schreibt. Mir sind z.Z. folgende Sachen bekannt:
README - allgemeine Informationen über Software;
INSTALL - Installationsanleitung;
HISTORY - Softwareänderungen (z.B. Funktion Xy wurde korrigieret etc.);
VERSION - Versionenübersicht (z.B. Version 1.1.0.22 feature 1, feature2, feature3 etc.)
Was kennt Ihr noch?
Danke für die Tipps!
Der folgende Beitrag wurde am 19. 02. 2009, 15:36 Uhr von hotti veröffentlicht.
hi,
> Was kennt Ihr noch?
RCS: Revision Control System
Hotti
--
Wenn der Kommentar nicht zum Code passt, kann auch der Code falsch sein.
Der folgende Beitrag wurde am 19. 02. 2009, 16:22 Uhr von Christoph veröffentlicht.
Moin.
> »» Was kennt Ihr noch?
>
> RCS: Revision Control System
RCS sind für Entwickler gedacht, die Dateien, die K.Bokov auflistet, für den Nutzer.
Ist der Funktionsumfang eines Programms groß genug, sollte ein Handbuch ('manual') in einem Format beiliegen, das einfache Navigation erlaubt (Manpages, HTML, Windows Help File, ...)
Christoph
Der folgende Beitrag wurde am 19. 02. 2009, 16:26 Uhr von suit veröffentlicht.
> HISTORY - Softwareänderungen (z.B. Funktion Xy wurde korrigieret etc.);
> VERSION - Versionenübersicht (z.B. Version 1.1.0.22 feature 1, feature2, feature3 etc.)
> Was kennt Ihr noch?
HISTORY oder VERSION kenne ich zusammeh hauptsächlich als "CHANGELOG"
Sieht meistens so aus:
Fix: xxx
Fix: xxx
Fix: xxx
Feature: xxx
Fix: xxx
Feature: xxx
Der folgende Beitrag wurde am 20. 02. 2009, 03:11 Uhr von Gass veröffentlicht.
Es fehlt noch eine Paketbeschreibung.
https://usefulinc.com/doap
Der folgende Beitrag wurde am 20. 02. 2009, 10:05 Uhr von K.Bokov veröffentlicht.
> Es fehlt noch eine Paketbeschreibung.
Das könnte man in README beschreiben.
Aber trotzdem Danke!
© 1998-2013 SELFHTMLImpressumSoftware: Classic Forum 3.4
