INFO: Dieses Forum nutzt Cookies...
Cookies sind für den Betrieb des Forums unverzichtbar. Mit der Nutzung des Forums erklärst Du dich damit einverstanden, dass wir Cookies verwenden.

Es wird in jedem Fall ein Cookie gesetzt um diesen Hinweis nicht mehr zu erhalten. Desweiteren setzen wir Google Adsense und Google Analytics ein.


Antwort schreiben 

Programmdokumentation



Wenn dein Problem oder deine Frage geklärt worden ist, markiere den Beitrag als "Lösung",
indem du auf den "Lösung" Button rechts unter dem entsprechenden Beitrag klickst. Vielen Dank!

02.08.2010, 11:04
Beitrag #5

danielsan Offline
LVF-Grünschnabel
*


Beiträge: 39
Registriert seit: Mar 2007

2011-SP1
2006
DE

22000
Deutschland
Programmdokumentation
Ich würde das so aufziehen:

Kontexthilfe: Sinn und Zweck von SubVIs, grobe Funktionsweise

Inline Kommentare im Blockdiagramm: Kniffligen Code erklären

Funktionsweise des Programms: Je nach Programmierstil, UML-Diagramme, Zustandsdiagramme, Klassendiagramme, etc...
Das hilft eigentlich auch schon vor bzw. während der Erstellung des Programms.

Hilfe für User des Programms: Kompilierte Html-Hilfe, die im Programm eingebunden ist.

Den ganzen Kram mit Screenshots und so zu dokumentieren halte ich für wenig hilfreich. Ein ordentliches Diagramm ist tausendmal hilfreicher.

Gruß,
Daniel
Alle Beiträge dieses Benutzers finden
Diese Nachricht in einer Antwort zitieren to top
30
Antwort schreiben 


Nachrichten in diesem Thema
Programmdokumentation - Matze - 01.08.2010, 15:07
Programmdokumentation - Y-P - 01.08.2010, 19:28
Programmdokumentation - Matze - 02.08.2010, 05:43
Programmdokumentation - dimitri84 - 02.08.2010, 06:48
Programmdokumentation - danielsan - 02.08.2010 11:04

Gehe zu: