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!

01.08.2010, 15:07
Beitrag #1

Matze Offline
LVF-Team
LVF-Team

Beiträge: 1.027
Registriert seit: Apr 2010

20xx
2010
DE_EN

7xxxx
Deutschland
Programmdokumentation
Hallo zusammen,

mir stellt sich die Frage, wie ich ein produktiv eingesetztes Programm am besten dokumentiere, sodass ich nach Wochen/Monaten wieder schnell nachvollziehen kann, was ich da gemacht habe. Das soll mir natürlich auch eine Fehlersuche vereinfachen, falls diese später erforderlich sein sollte.

SubVIs dokumentiere ich über diesen Kontexthilfentext und damit bin ich auch sehr zufrieden.
Nur bin ich mir nicht sicher, wie ich das Programm selbst gut dokumentieren kann. Und zwar so, dass eine Archivierung der Doku z.B. im PDF-Format möglich ist.

Ich stelle mir so etwas in der Art vor: Die Doku wird z.B. mit Word erstellt.
Dann kommen allgemeine Hinweise. Evtl. mit Screenshot des Hauptprogramms und kurzen Erklärungen dazu (paralleles Einlesen von dies und jenem, Initialisierung etc).
Dann folgen Screenshots von SubVIs o.ä., die erläutern, was wo gemacht wird.
Nur ob das professionell ist, weiß ich nicht. Und professionell soll das schon aussehen.

Die "Doku", die LabVIEW generieren kann, ist meiner Meinung nach nicht gut. Da sehe ich dann die Hierarchie des Programms und Screenshots aller SubVIs mit sämtlichen Case-Fällen etc.

Was hat sich denn bewährt bzw. wie dokumentiert ihr eure Programme?

Grüße
Alle Beiträge dieses Benutzers finden
Diese Nachricht in einer Antwort zitieren to top
01.08.2010, 19:28
Beitrag #2

Y-P Offline
☻ᴥᴥᴥ☻ᴥᴥᴥ☻
LVF-Team

Beiträge: 12.612
Registriert seit: Feb 2006

Developer Suite Core -> LabVIEW 2015 Prof.
2006
EN

71083
Deutschland
Programmdokumentation
(Fast) gar nicht. Da wo es richtig knifflig in meinem Programm ist, mache ich mir ein Textfeld ins Blockdiagramm. Den Rest programmiere ich so modular (übersichtlich), dass ich gar keine Doku mache.
Ich bin aber auch Einzelkämpfer bei uns in der Firma (was LabVIEW angeht), so dass niemand bei meinem Programm durchsteigen muss. Im Team sollte man schon umfangreicher dokumentieren.

Gruß Markus

' schrieb:wie dokumentiert ihr eure Programme?

--------------------------------------------------------------------------
Bitte stellt mir keine Fragen über PM, dafür ist das Forum da - andere haben vielleicht auch Interesse an der Antwort !!
--------------------------------------------------------------------------
Alle Beiträge dieses Benutzers finden
Diese Nachricht in einer Antwort zitieren to top
02.08.2010, 05:43
Beitrag #3

Matze Offline
LVF-Team
LVF-Team

Beiträge: 1.027
Registriert seit: Apr 2010

20xx
2010
DE_EN

7xxxx
Deutschland
Programmdokumentation
' schrieb:Ich bin aber auch Einzelkämpfer bei uns in der Firma (was LabVIEW angeht)
So ist es bei mir ebenfalls (noch), allerdings wäre mir eine Doku schon lieber. Da soll nicht jede Addition dokumentiert sein, aber die Programmstruktur, das allgemeine Vorgehen u.ä.
Es könnten natürlich zusätzlich Dinge vermerkt sein wie die verwendete LabVIEW-Version. Nicht, dass ein Programm unter LV 2009 entwickelt und in LV 2010 angepasst wurde und ein Überspielen auf ein Echtzeitsystem daher ohne weiteres nicht mehr möglich ist (neues Betriebssystem muss drauf und je nach Situation ist das aus der Ferne nicht möglich).
Also ganz allgemeine Dinge sollten dort auch enthalten sein.

Kommentare verwende ich im Blockdiagramm schon.

Das geht natürlich z.B. über ein Word-Dokument. Ich wollte mich nur mal umhören, ob es da etwas besseres für die Dokumentation gibt (von der Art, nicht vom Programm).

Grüße
Alle Beiträge dieses Benutzers finden
Diese Nachricht in einer Antwort zitieren to top
02.08.2010, 06:48 (Dieser Beitrag wurde zuletzt bearbeitet: 02.08.2010 06:50 von dimitri84.)
Beitrag #4

dimitri84 Offline
Astronaut
*****


Beiträge: 1.496
Registriert seit: Aug 2009

2020 Developer Suite
2009
DE_EN

53562
Deutschland
Programmdokumentation
Hier gab's ein paar Tips. Vielleicht ist der Vorschlag von SeBa oder Schrotti was für dich.

Im Endeffekt muss hier nur eine weitere Person außer mir die VI's nachvollziehen können. Dafür reichen mir Kontexhilfe und Blockdiagrammkommentare.

Gruß dimitri

„Sag nicht alles, was du weißt, aber wisse immer, was du sagst.“ (Matthias Claudius)
Webseite des Benutzers besuchen Alle Beiträge dieses Benutzers finden
Diese Nachricht in einer Antwort zitieren to top
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 


Gehe zu: