LabVIEWForum.de - Dokumentation eines LabVIEW-Projekts

LabVIEWForum.de

Normale Version: Dokumentation eines LabVIEW-Projekts
Du siehst gerade eine vereinfachte Darstellung unserer Inhalte. Normale Ansicht mit richtiger Formatierung.
Hallo,

ich stehe derzeit vor dem Problem, dass ich ein LabVIEW-Projekt analysieren und dokumentieren soll, bei dem ca. 200 VIs verwendet und miteinander vernetzt wurden. Es handelt sich um ein Hardware-in-the-loop-System, bei dem u. a. umfangreiche VIs zur Auswertung und Generierung von CAN-Nachrichten erstellt wurden (siehe Bild mit Teilausschnitt).

[attachment=8476]

Die Darstellung als VI-Hierarchie ist hierbei natürlich sehr unübersichtlich und gibt wenig Aufschluss. Es existieren bisher auch keine Struktogramme, Operationsdiagramme o. ä.; die VIs wurden im Rahmen des Projekts von den Entwicklern "einfach" erstellt Wink

Meine Fragen dazu:

1) Gibt es neben der Hierarchie-Darstellung von LV noch andere Tools, mit dem man z. B. Datenflüsse und -typen innerhalb von VIs darstellen kann?

2) Welche Methoden zur strukturierten Systemanalyse und -dokumentation würden sich eignen?

3) Ist bei derart umfangreichen Systemarchitekturen eine nachträgliche Analyse und Dokumentation überhaupt noch sinnvoll möglich?


Danke für Euere Antworten!

Chris
Unter File:Print kannst du auch diverse Infos dokumentieren und in verschiedenen Formaten ausgeben.

Aber wozu dokumentieren, guter LV-Code ist doch selbsterklärendWink

Vielleicht geht es so.
was genau ist dass ziel das du verfolgst?
was willst du am ende der "analyse" haben?

warum machst du es?

also ich mache momentan eine maturaarbeit und musste da auch auf ein anderes programm aufbauen(war zwar sicherlich nicht so extrem umfangreich jedoch uach ganz schön beträchtlich) deshalb musste ich mich natürlich auhc damit auseinandersetzten wie es funktioniert und was es macht.
ich habe es anfangs auch mit der vi hierachy gemacht jedoch war dies immernoch "sehr" kompliziert.
also hab ich einfaach versucht das programm zu verstehen bin einfach alles schritt für schritt durchgegangen und mit der Zeit kommt man dann richtung in übung gekommen und man sieht dann ziemlich schnell was ein teil vi macht.

ich weis es wird dir nicht wirklich helfen
aber ich weis auch nicht wie man es sonst machen sollte!
' schrieb:was genau ist dass ziel das du verfolgst?
was willst du am ende der "analyse" haben?

warum machst du es?

also ich mache momentan eine maturaarbeit und musste da auch auf ein anderes programm aufbauen(war zwar sicherlich nicht so extrem umfangreich jedoch uach ganz schön beträchtlich) deshalb musste ich mich natürlich auhc damit auseinandersetzten wie es funktioniert und was es macht.
ich habe es anfangs auch mit der vi hierachy gemacht jedoch war dies immernoch "sehr" kompliziert.
also hab ich einfaach versucht das programm zu verstehen bin einfach alles schritt für schritt durchgegangen und mit der Zeit kommt man dann richtung in übung gekommen und man sieht dann ziemlich schnell was ein teil vi macht.

ich weis es wird dir nicht wirklich helfen
aber ich weis auch nicht wie man es sonst machen sollte!

Hi pope89,

das Ziel der Analyse ist, die entwickelten LabVIEW-VIs erstens zu verbessern und zweitens auf ihren universellen Einsatz hin zu überprüfen. Momentan wird das fertige Programm nur für eine ganz bestimmte Aufgabe eingesetzt, im weiteren Verlauf sollen die VIs jedoch so angepasst werden, dass praktisch jede beliebige Messaufgabe damit erledigt werden kann. Dokumentiert werden muss, weil's die Firma bzw. Kunden so wollen Wink

Das eigentliche Problem besteht weniger im Verständnis der VIs, als darin, dass ich einen Weg finden muss, um die Funktionalität der VIs prägnant darzustellen. Einerseits soll es nicht bei einer reinen Funktionsbeschreibung bleiben (z. B. "CAN-Bus auslesen"), andererseits sind die VIs aber zu komplex und miteinander vernetzt, um Details wie Schleifen, Verzweigungen, etc. zu beschreiben. Wink

Grüße,

Chris
' schrieb:Hallo,

ich stehe derzeit vor dem Problem, dass ich ein LabVIEW-Projekt analysieren und dokumentieren soll, bei dem ca. 200 VIs verwendet und miteinander vernetzt wurden. Es handelt sich um ein Hardware-in-the-loop-System, bei dem u. a. umfangreiche VIs zur Auswertung und Generierung von CAN-Nachrichten erstellt wurden (siehe Bild mit Teilausschnitt).

[attachment=35304:hierarchie2.JPG]

Die Darstellung als VI-Hierarchie ist hierbei natürlich sehr unübersichtlich und gibt wenig Aufschluss. Es existieren bisher auch keine Struktogramme, Operationsdiagramme o. ä.; die VIs wurden im Rahmen des Projekts von den Entwicklern "einfach" erstellt Wink

Meine Fragen dazu:

1) Gibt es neben der Hierarchie-Darstellung von LV noch andere Tools, mit dem man z. B. Datenflüsse und -typen innerhalb von VIs darstellen kann?

2) Welche Methoden zur strukturierten Systemanalyse und -dokumentation würden sich eignen?

3) Ist bei derart umfangreichen Systemarchitekturen eine nachträgliche Analyse und Dokumentation überhaupt noch sinnvoll möglich?
Danke für Euere Antworten!

Chris

Hallo,
ich nutze die Baumstruktur um z.B. unseren CPP Hackern :cool:den Ablauf der Programme zu erklären.
Zunächst klicke ich alle SUB Strukturen unterhalb der ersten SUBs (kleines Dreieck) weg.

Das ist bei deinem Tree auch möglich dann in Word konvertiert und dann z.B. die ersten wichtigen SUBs erklären.

Mit klick auf die SUB markieren dann Print documentaion, dann icon selct, dann icon discription, hier wird die alles zur Sub angezeigt Vorschau, alles andere Versteht sich dann von selber.

Mit minimalen Aufwand habe ich so schon einiges gegenüber Entwicklungspartnern klären können, dass macht LV so unschlagbar gegenüber jeden manuellen Script, d.h. selbst nachträgliche Dokumentation ist damit kein Problem.

Gruß Reiner
Ich wollte nur ganz allgemein etwas zum Thema Dokumentation sagen:

Jede Dokumentation hat letztlich den Sinn, auch anderen, die ursprünglich nichts mit dem Projekt zu tun hatten, den Einstieg zu ermöglichen (Eingeschlossen dabei die Funktion als Gedächnisstütze für die Beteiligten),

Die Chancen dafür stehen meines Erachten bei LabVIEW viel besser als bei den textorientierten Programmiersprachen. Vorausgesetzt natürlich, der Code ist übersichtlich und es sind genügend erklärende Kommentare in den VIs, wie das auch bei anderen Sprachen selbstverständlich sein sollte.

Nur gibt es dabei ein psychologisches Handicap: Es ist nämlich nicht möglich, ein schönen Leitz-Ordner anzulegen, damit zum Chef zu gehen und zu sagen: Bitte schön, das hier ist die Dokumentation des Programms.

D.h. möglich wäre das schon, aber wenn man die Blockdiagramme ausdruckt versteht sie wirklich kein Mensch mehr. Die Cases, Hierarchien usw. können wirklich nur am lebenden Quellcode am Computer nachempfunden werden.

PS: Man stelle sich nur mal vor, die vielen hochgeladenen VIs hier im LVF würden nur aus Programmtext (von mir aus auch mit Flußdiagrammen) bestehen und andere sollten den Code beurteilen. Vielleicht wäre das möglich, aber Spaß daran hätte wohl niemand mehr, und ob es dann noch so viele freiwillige Helfer hier geben täte...
Danke für Euere Antworten, Ihr habt mir viel weitergeholfen. Cool

Meine derzeitige Vorgehensweise besteht jetzt darin, dass ich zunächst die VIs der oberen Hierarchiestufen dokumentiere und zu jedem dieser VIs Input- und Outputmodule sowie die zugehörigen Datentypen beschreibe. Den Datenfluss zwischen den VIs stelle ich in einer zweidimensionalen Tabelle dar.

Vielleicht hat ja jemand noch eine andere Idee.
' schrieb:Vielleicht hat ja jemand noch eine andere Idee.
Ein winzig kleine, und nicht einmal von mir, sondern aus einem Lehrbuch (Johnson & Jennings).
Die Benennung von Netzen oder Datentypen so machen:
[attachment=8496]
Referenz-URLs