Einzelnen Beitrag anzeigen

mm1256

Registriert seit: 10. Feb 2014
Ort: Wackersdorf, Bayern
642 Beiträge
 
Delphi 10.1 Berlin Professional
 
#15

AW: Eure favorisierte Form der Dokumentation

  Alt 12. Jul 2015, 12:45
Hallo,

externe Doku mit Word hat sich nicht bewährt. Zu umständlich, schwer zu pflegen, und wenn man was sucht oder braucht war es oft nicht aktuell. Die wichtigsten (programmier-)technischen Hinweise stehen darum im Quelltext. Für globale Zusammenhänge bei mehreren Modulen und die interne Dokumentation gibt es ein kleines Selbstgestricktes (DB, ein paar indizierte Felder zum schnellen Auffinden und ein Memo mit der Doku, sowie ein DateTimeFeld und ein User-Feld welche bei einer Änderung automatisch gesetzt werden. Dann weiß man immer automatisch, wer war's) und ansonsten gilt die Devise: Die Hilfe ist die beste Dokumentation. Darum ist bei Abschluss eines dokumentationswürdigen Vorganges sofort der Eintrag im Hilfesystem (Help&Manual) vorzunehmen, denn es müssen ja, damit die kontextsensitive Hilfe funktioniert, im OI auch die Werte des HelpContext gesetzt werden.
Gruss Otto PS: Sorry wenn ich manchmal banale Fragen stelle. Ich bin Hobby-Programmierer und nicht zu faul die SuFu zu benutzen
  Mit Zitat antworten Zitat