Programmdoku

Von der Installation bis zur Auslieferung der Applikation

Moderator: Moderatoren

Antworten
stevie
Rekursionen-Architekt
Rekursionen-Architekt
Beiträge: 417
Registriert: Mo, 17. Sep 2007 18:20
Wohnort: Senftenberg
Kontaktdaten:

Programmdoku

Beitrag von stevie »

Was gehört eigentlich alles in die Programmdokumentation eines xBase++-Programms hinein?
Benutzeravatar
brandelh
Foren-Moderator
Foren-Moderator
Beiträge: 15695
Registriert: Mo, 23. Jan 2006 20:54
Wohnort: Germersheim
Hat sich bedankt: 65 Mal
Danksagung erhalten: 33 Mal
Kontaktdaten:

Beitrag von brandelh »

Hi,

ich denke dass eine Programmdokumentation nicht von der Programmiersprache abhängig ist.
Solltest du allerdings den Quellcode mitliefern müssen, wäre natürlich der nötige Compiler inkl. Versionsstand und Tools wichtig.
Eventuell auch Vorgaben für die Installation der Entwicklungsumgebung, d.h. wie und wo der Quellcode liegen muss falls fixe Pfadangaben verwendet wurden.

Ansonsten gehört die Aufgaben und Problembeschreibung, Programmablaufplan (oder neuere Planarten ?) und Absprachen (also so eine Art von Pflichtenheft) sowie eine Produktbedienungsanleitung dazu.

Ganz beliebt ist auch eine Abhandlung darüber, für was der Hersteller alles nicht haftet ;-)
Gruß
Hubert
Benutzeravatar
AUGE_OHR
Marvin
Marvin
Beiträge: 12906
Registriert: Do, 16. Mär 2006 7:55
Wohnort: Hamburg
Hat sich bedankt: 19 Mal
Danksagung erhalten: 45 Mal

Beitrag von AUGE_OHR »

hi,

die Frage ist : Für wen ist die Dokumentation gedacht ?
User : Die wollen ein Handbuch, schön mit bunten Bildern (Snapshot)
Programmierer : Cross-Referencen, DBF- und Index- Table etc.

Während ich dir beim 1st. nicht weiterhelfen kann würde ich bei 2st.
sagen : SNAP, DFLOW und natürlich CLICK.
SNAP und DFLOW verstehen nur Cl*pper v5.x Syntax und kommen
nicht mit CLASS zurecht. Von Click gibt es eine Xbase++ Version von
Olaf die du hier findest : http://www.combifinanz.de/tools/

Allerding sollte man bei Click auf S87(!!!) einstellen da sonst die v5.x
"optimierung" aktiv wird die Ärger machen können.

gruss by OHR
Jimmy
Antworten