Konzepte Dokumentation

[pluto]

Hallo,
ich habe ein Konzept Entwickelt, für eine GUI. Dieses Konzept ist recht "Kompliziert" und "Komplex" aufgebaut. Ich selbst musste mich erst mal, daran gewöhnen. Jede Komponente wird zur Herausforderung. Es mag leichtere und einfachere Konzepte für GUI'S geben. Das Konzept ist jedoch auch auf der anderen Seite, sehr "Dynamisch und Flexibel", diese Punkte sind mir sehr wichtig. Ohne jetzt das Konzept genauer zu beschreiben, würde ich gerne wissen, wie man am besten eine "Dokumentation" dazu schreiben könnte.

Ich habe schon zwei bis drei mal angefangen damit und immer war ich unzufrieden. Der Grund: Meistens Fehlte vieles oder ich wusste nicht wie ich es am besten einteilen sollte. Außerdem würde ich zum Konzept gerne ein Video erstelle und eine Präsentation. Ich kann mit den Notwendigen Programmen umgehen. Ich weiß nur nicht wie ich einen Passenden Inhalt erstellen soll. Außerdem möchte ich natürlich auch eine kleine Hompage drumherum bauen. Als Anlaufstelle.

Grafisch ist noch nicht viel zu sehen. Einen Prototypen gibt es zwar. Aber dort gibt es erst vier Komponenten: Ein Container(Vergleichbar mit dem Panel), ein Label, ein Button und ein CheckButton. Die Möglichkeiten sind jedoch sehr, sehr vielseitig.

Ich bin jetzt an einem Punkt angelangt, wo ich gerade Festelle, dass es doch recht Aufwendig ist mit diesem Konzept. Wenn es hilft, kann ich gerne den Prototypen ranhängen oder die Versuche, die ich gemacht habe mit der "Dokumentation". Der Prototyp wird euch nicht viel nutzen. Er ist recht unübersichtlich im Moment, wobei ich wäre gespannt wie lange einer von euch bräuchte sich da drin zu recht zu finden und sogar Komponente erstellen könnte, die zum "Konzept" passen.

In diesen Thread geht es nur um die Frage: Wie kann ich ein Konzept am besten Dokumentieren, Präsentieren, Video und ein Hompage erstellen. Wobei es weniger um die Technik geht sondern viel mehr um den Inhalt.
Der Soll auf der einen Seite Professionell klingen, aber auch deutlich alle Vor und Nachteile dieses Konzeptes da stellen.
Es soll nicht um die Frage gehen: Welches Konzept ist das beste für eine GUI ? oder welches Konzept würdet ihr verwenden.


Könnt ihr mir zu diesen Problem Ratschläge / Tipps oder Vorschläge geben ? Wie ich vor gehen sollte.

[Hitman]

Wenn das Vorhaben zu komplex wird, dann bau dir Modelle. Ich würde UML empfehlen. Bastel dir Klassendiagramme zu deiner Implementierung, erstell Aktivitätendiagramme für den geplanten Ablauf, vlt. ein paar Use-Case-Diagramme als "Beispiele". Schau dir auch die anderen Diagrammtypen an, vlt. passt eins davon noch besser zu deinem Verständnis von Dokumentation, dann bietet es sich an, das auch noch zu machen

[pluto]

Wie könnte so ein UML-Programm aussehen ? Ich kann es mir beim besten willen nicht vorstellen.

[Hitman]

Beispiele für die diversen UML Diagramme findet man verlinkt hier: http://en.wikipedia.org/wiki/Unified_Modeling_Language" onclick="window.open(this.href);return false;

[pluto]

Ich verwende lieber den Deutschen Link: http://de.wikipedia.org/wiki/Unified_Modeling_Language" onclick="window.open(this.href);return false;
Leider ist es damit noch nicht getan. Im Moment versuche ich eine Passende Gliederung zu erstellen. An die ich mich "halten" kann. Das Darstellen der Klassen ist auch Bestandteil des Problems. Leider.

[Lannes]

Hallo,

Google ist dein Freund und meiner.

Mit den Suchbegriffen "Dokumentation Komponente Tutorial" habe ich das gefunden:
http://www.knowgravity.com/pdf-d/DOC-R3.pdf" onclick="window.open(this.href);return false;

[pluto]

Danke ! Es ist jedoch zu "Allgemein" gehalten.

Ich habe jetzt noch einen dritten Versuch gestartet. Hier habe ich heute fünft Seiten geschrieben.

Falls es Fertig wird, lade ich es hier hoch. Mich würde Interessieren was ihr von der "Beschreibung" haltet. Ob das Konzept gut ist oder nicht, ist eine andere Frage.

Es ist mein erster Versuch so ein "Komplexes" und "Kompliziertes" Konzept so genau wie nur irgendwie Möglich zu beschreiben. Das Konzept habe ich komplett "alleine" Entwickelt. Eure "Vorschläge" könnten noch eingearbeitet werden. Klassen-Diagramme möchte ich auch noch erstellen. Das Problem dabei ist: Ich habe sehr, sehr viele Klassen. ca zwischen 20 und 30 Stück, es können aber auch mehr sein.

[Socke]

Wichtiger als die reine Form ist meines Erachtens der Inhalt. Wenn ich in der GTK2-Dokumentation wühle, weiß ich nicht, in welcher Reihenfolge ich die Funktionen aufrufen muss, damit ich zu dem gewünschten Ergebnis komme (speziell auf das Laden von Icons bezogen). Daher muss auch jede Klasse so dokumentiert werden, dass daraus hervorgeht, was ich damit machen kann und passende Beispiele sollten in die Dokumentation eingebettet werden (ein Link, der die entsprechende Datei öffnet wäre auch noch möglich).

[pluto]

Wichtiger als die reine Form ist meines Erachtens der Inhalt.

Genau das war ein Teil meiner Frage....

Daher muss auch jede Klasse so dokumentiert werden, dass daraus hervorgeht, was ich damit machen kann und passende Beispiele

Ich habe ein ganzen Kapitel vorgesehen, was sich "nur" mit Beispielen beschäftigt. Um zu Zeigen wie die Klassen Anwendbar sind. Das ist ein Punkt der mich bei anderen "Dokumentation" sehr stört. Meistens werden einfach nur "blind" die Funktionen und Klassen beschrieben, aber wie rufe ich sie auf ? Welche Reihenfolge ist vor gesehen ? Selbst wenn ich weiß was eine Klasse macht, nützt mir diese Information wenig. Wobei es hier auch auf die Klasse ankommt. Z.B. bei TStringList ist das ja recht leicht. Aber bei komplizierten Konzepten ist das nicht ganz so leicht. Z.B. bei der Dokumentation von XINE oder MPlayer oder GTK2 oder sonst was.