kleine Fragen bzgl. Doku-Inhalte

[thunder85]

Derzeit schreiben viele, darunter auch ich, an der Doku für die AP 2010.

Jedoch schwirren mir noch einige wenige Fragen im Kopf herum, vielleicht weiß hier jemand Rat...

1.) Spiralmodell

Mein Projekt ist eine Anwendung, die ich in mehreren Schritten entwickelt habe. Immer eine Komponente, lösgelöst vom ganzen, dann integriert. So habe ich nach und nach - gemäß dem Pflichtenheft - das Projekt erstellt. Für jede Komponente habe ich getestet, usw. Daher dachte ich daran, explizit das Spiralmodell zu nennen in der Doku bzgl. der Projektphasen. Nun frage ich mich aber, wie ich es am Besten verwenden kann. Hat jemand Vorschläge, wie man die Abläufe der Konzeption, Implementierung und Testing anhand des Spiralmodells gut schildern kann?

2.) Tabellen vs. Fließtext

Um den Fließtext zu lockern und die Lesbarkeit zu erhöhen, habe ich bereits für die Zeit (Soll & Ist) Tabellen erstellt. Nun bieten sich weitere Kapitel, z.B. Kostenplanung an. Sparsam umgehen, Tabellen möglichst vermeiden oder doch ausführlich einsetzen um besser zu visualisieren? Immerhin benötigen Tabellen mehr Platz als Fließtext und es soll nicht der Eindruck entstehen, dass ich nur Platz verschwenden will.

3.) Grafiken & Diagramme

Ich füge alle Grafiken und Diagramme in Anhänge. Da wären ein UseCase (UML) und ein ERM. Da es eine RIA ist, die MVC verwendet, denke ich über ein Klassendiagramm nach, aber es sind nur drei Klassen, der Controller und die Views... Vielleicht eine Ordnerstruktur als Diagramm? Oder ein GANTT als Übersicht des gesamten Projekts? Was meint ihr, welche sollten drin sein?

4.) Verweise auf Anhänge

An einigen Stellen möchte ich auf Anhänge verweisen, z.B. auf Abb. X in Anhang B oder Codeschnippsel Y in Anhang A. Wie am besten verweisen, da die einzelnen Dinge in unterschiedlichen Anhängen sind? Vllt so - (vgl. Anhang B, Abb. X)?

[lupo49]

4.) Verweise auf Anhänge

An einigen Stellen möchte ich auf Anhänge verweisen, z.B. auf Abb. X in Anhang B oder Codeschnippsel Y in Anhang A. Wie am besten verweisen, da die einzelnen Dinge in unterschiedlichen Anhängen sind? Vllt so - (vgl. Anhang B, Abb. X)?

Da würde ich an die Stelle eine Fußnote einfügen und in der Fußnote dann schreiben: vgl. Anhang I, S. 45, Abbildung foo

[thunder85]

Danke für den Hinweis. Fußnoten sollen wir vermeiden, aber die Form des Verweises ist gut. Es sind nicht viele Verweise, das meiste ist - typisch Doku - Bla, Bla.

[Akku]

Grundsätzlich ist das ein schwieriges Thema. Es gibt Prüfer, die erwarten ein Fließtext von Seit 1 bis Seite 30 und den Rest im Anhang. Wirklich nicht negativ gemeint. Auf der anderen Seitze, gibt es Prüfer, die eher den -leicht- kaufmännischen Aspekt sehen (schließlich ist ein FI zu einem drittel Kaufmann) und schon ein paar Grafiken und, vor allen Dingen, Tabellen erwarten. Schauen wir mal:

1.) Spiralmodell

....Hat jemand Vorschläge, wie man die Abläufe der Konzeption, Implementierung und Testing anhand des Spiralmodells gut schildern kann?...

Hast du doch im Prinzip schon.

2.) Tabellen vs. Fließtext

Um den Fließtext zu lockern und die Lesbarkeit zu erhöhen, habe ich bereits für die Zeit (Soll & Ist) Tabellen erstellt. Nun bieten sich weitere Kapitel, z.B. Kostenplanung an. Sparsam umgehen, Tabellen möglichst vermeiden oder doch ausführlich einsetzen um besser zu visualisieren? Immerhin benötigen Tabellen mehr Platz als Fließtext und es soll nicht der Eindruck entstehen, dass ich nur Platz verschwenden will.

Natürlich sehen wir es gern, dass eine Kosten/Nutzen-Analyse mit Tabellen aufgearbeitet wurde. Natürlich sehen wir es gern, wenn ein Break-Even grafisch dargestellt wird. Und das nicht im Anhang.

3.) Grafiken & Diagramme

Ich füge alle Grafiken und Diagramme in Anhänge. Da wären ein UseCase (UML) und ein ERM. Da es eine RIA ist, die MVC verwendet, denke ich über ein Klassendiagramm nach, aber es sind nur drei Klassen, der Controller und die Views... Vielleicht eine Ordnerstruktur als Diagramm? Oder ein GANTT als Übersicht des gesamten Projekts? Was meint ihr, welche sollten drin sein?

Drei Klassen abzubilden ist schon etwas spärlich. Was hälst du davon, wenn du zusätzlich ein Seq.-Diagramm einsetzt. Da UML Diagramme zum Projekt und zur Softwareentwicklung in der Designphase unmittelbar zum Projekt gehören, erwarten wir die Diagramme, dort wo auf sie eingegangen wird.

4.) Verweise auf Anhänge

An einigen Stellen möchte ich auf Anhänge verweisen, z.B. auf Abb. X in Anhang B oder Codeschnippsel Y in Anhang A. Wie am besten verweisen, da die einzelnen Dinge in unterschiedlichen Anhängen sind? Vllt so - (vgl. Anhang B, Abb. X)?

Genau so.

Bitte denke an meine einleitende Worte. Ich möchte nicht pauschalisieren und gebe nur die Meinung und Sichtweise unseres Prüfungsauschusses wieder. Solange du keine Auflagen bzgl. der Doku seitens deiner IHK hast, wird man dir jedoch keine Punkte abziehen können, wenn du dich an die von mir aufgezählten Dinge hältst.

[thunder85]

Danke für die vielen Hinweise, Akku. Werde dann schauen, ob die grafische BEP Analyse noch in die 10 Seiten, so die Vorgabe IHK Hannover, passen, oder nicht. Tabellen habe ich dahingehend ergänzt, dass diese die Planung (SOLL), die tatsächlichen Zahlen (IST), sowie deren Differenzen veranschaulichen. Zu jeder Tabelle Erläuterungen, damit ersichtlich ist (sein soll), dass ich die Zahlen auch auswerten und in Relation setzen kann.

Klassendiagramm für ein kleines Projekt mit 70 Std. wäre auch meiner Meinung nach nicht so sinnvoll. Sequenzdiagramm klingt interessant, vielleicht an einem konkreten Beispiel aus der Funktionalität. Mal schauen, wo es passt.

Es wird hoffentlich nicht erwartet, dass ich jede Funktionen mit Diagrammen versehe. Dachte bisher an die Offensichtlichen, das Use Case als Einstieg, ERM der alten und neuen Datenbank, Sequenz-, bzw. Aktivitätsdiagramm für interessante Funktionen der Anwendung.

Bzgl. dem BEP stellt sich mir eine Frage, da es sich bei meinem Projekt um eine kostenlose Zusatzleistung des Unternehmens handelt, die Arbeitszeiten verringen soll. Darüber habe ich den BEP ermittelt, jeweils für SOLL und IST. Wären zwei separate Grafiken in den jeweiligen Bereichen oder eine gemeinsame im Zeitvergleich sinnvoller?

EDIT:

Bzgl. dem Spiralmodell frage ich mich, ob ich es im Rahmen der Projektrealisierung erwähnen soll, oder explizit vorher bei der Planung erläutern soll. Derzeit beschreibe ich nur, dass einzelne Komponenten implementiert und getestet werden, danach zur Gesamtanwendung hinzugefügt und erneut getestet werden. Danach beginnt das Spiel von vorne für die folgende Komponente.

Wo würdet ihr das zu Grunde liegende Modell erwarten und wie ausführlich erläutern?

Bearbeitet 3. Mai 2010 von thunder85
Weitere Fragen eingefallen ;)