Bitte um Bewertung meines Projektantrages

[from.hell]

Hallo, ich bin FIAE im 3. Lehrjahr und habe diesen Sommer meine Abschlussprüfung.

Derzeit bin ich damit beschäftigt meinen Projektantrag zu schreiben ( Abgabezeitraum 16.01 - 01.02, IHK Koblenz ).

Dazu habe ich mich u.a. hier im Forum umgesehen und daraufhin meinen Projektantrag geschrieben, ich möchte euch bitten diesen zu bewerten.

Kurze Erklärung zum Projekt: Wir sind 2 Azubis für FIAE und derzeit wird eigentlich nicht richtig dokumentiert, wenn überhaupt schreibt man hier etwas "per Hand" ins Wiki rein, aber das ist auch nicht wirklich das wahre. Deshalb soll jetzt Insource-Doku geschrieben werden und mein Kollege soll den Parser schreiben, der die Insource-Doku ausliest und in ein XML - Dokument ablegt. Das ist sein Abschlussprojekt. Mein Projekt soll sein, die XML - Struktur aufzugreifen und daraus dann eine Wiki - Seite (HTML und BB - Code glaub ich) zu erstellen bzw (das wurde aber als KANN - Bedingung aufgestellt) das ganze in ein PDF Dokument auszugeben. Halt das man alles "nur einmal" schreiben muss. Einmal im Monat läuft dann der große Compile, an dem alle Files auf dem Server compiliert werden, da soll das Programm dann mitlaufen, ansonsten halt wenn ein Programmierer etwas neu gemacht hat und er das nun dokumentieren möchte. Ich hoffe die kurze Erklärung reicht, falls doch noch Fragen offen sind einfach melden

Vielen Dank für jede Antwort!

1 Thema der Projektarbeit

Umsetzen einer XML – Struktur in das firmeninterne Doku – Wiki

2 Geplanter Bearbeitungszeitraum

Beginn: 05. März 2012

Ende: 30. März 2012

3 Projektbeschreibung

Bei der Firma XXX gibt es in der Fachabteilung Programmierung derzeit neun Mitarbeiter, die täglich neue Programme nach Kundenanforderung erstellen. Derzeit wird jedes Programm, welches erstellt wird, insgesamt drei Mal dokumentiert: Im Quellcode, im Doku-Wiki und in einem Text-Dokument. Die Quellcode-Dokumentation dient den Anwendungsentwicklern als Hilfestellung, wenn sie ein bestehendes Programm bearbeiten müssen, das Doku-Wiki dient den Anwendungsentwicklern um einen schnelleren und besseren Überblick über die internen Prozeduren, Betriebslogiken und Klassen zu behalten und das Text-Dokument dient außenstehenden Personen um die Arbeit der Abteilung besser nachvollziehen zu können. Da diese dreifache Arbeit sehr viel Zeit in Anspruch nimmt wird nach einer Lösung gesucht um aus drei Dokumentations – Vorgängen einen zu machen. Hierzu wurde vom Auftraggeber, Herrn XXX, beschlossen, dass ein Quellcode – Parser erstellt werden soll, der die Quellcode-Dokumentation ausliest und in direkt in das Doku – Wiki auslagert. Außerdem soll möglich sein, die Dokumentation in ein PDF – Dokument auszugeben. Meine Aufgabe wird nun sein, die Schnittstelle zwischen dem XML – Dokument und dem Doku – Wiki / PDF – Dokument zu bilden. Das Programm soll ausgewählte XML – Dokumente einlesen und für jedes Dokument einen neuen Doku – Wiki – Menüpunkt anlegen bzw. als PDF – Dokument ausgeben. Des weiteren soll es interne Verweise bilden können, sobald ein Fachbegriff / eine Bezeichnung verwendet wird. Der Fachbegriff / die Bezeichnung wird somit direkt mit dem bestehenden Hauptartikel verlinkt.

4 Projektumfeld

Die Vorbereitung und die Integration der Dokumentations-Software sowie die Dokumentation des Projektes findet in der Abteilung Programmierung der Firma XXX statt. Auftraggeber für dieses Projekt ist Herr XXX, Leiter der XXX Programmierung, Projektbetreuer ist Herr XXX, Anwendungsentwickler der Firma XXX.

5 Projektphasen mit Zeitplanung

Vorbereitung ( 2 Std. )

• Analyse Ist- und Sollzustand ( 2 Std. )
  

Durchführung ( 48 Std. )

• Grobes Konzept erstellen ( 1 Std. )
  
• Erstellen eines Programmablaufplanes ( 1 Std. )
  
• Erstellen der Betriebslogik zum Umsetzen der XML Struktur in eine Doku – Wiki – Seite ( HTML und BB-Code ) ( 30 Std. )
  
• Erstellen eines benutzerfreundlichen User – Interfaces ( 15 Std. )
  
• Verbinden von Betriebslogik und User – Interface ( 1 Std ).
  

Fehlerkorrektur ( 6 Std. )

Kontrolle und Testphase ( 6 Std. )

• Testen auf Zusammenarbeit mit Quellcode – Parser ( 1 Std. )
  
• Testen auf korrekte Erstellung der Doku – Wiki – Seiten ( 1 Std. )
  
• Testen auf volle Funktionsfähigkeit ( 3 Std. )
  
• Testen auf Benutzerfreundlichkeit (1 Std. )
  

Projektdokumentation ( 8 Std. )

• Dokumentation erstellen ( 8 Std. )
  

Gesamtzeit: 70 Std.

6 Dokumentation zur Projektarbeit

Erstellung einer Projektdokumentation mit Anhang, Glossar und Quellenangabe.

7 Anlagen

keine

8 Präsentationsmittel

Vorhanden: Flipchart, Tageslichtprojektor, Pinnwand

Mitgebrachte Präsentationsmittel: Notebook und Beamer

[metux]

Da denk ich doch gleich an Doxygen ...

An der Stelle würd ich Dir raten, Dich neben der eigentlichen Dokumentationsgeschichte auch mit den

Dahinterliegenden Workflows zu beschäftigen: wie arbeiten die Leute aktuell und wie könnte man

es besser machen (unter Zuhilfenahme Deiner zu entwickelnden Tools). Dabei dann vielleicht auch

mal eine vorsichtige Schätzung wagen, wieviele Resourcen damit zukünftig eingespart werden könnten.

[from.hell]

Doxygen geht leider nicht bei unserer Programmiersprache (Progress..).

Angeblich könnte Doxygen es zwar lernen, aber die Firma möchte lieber etwas eigenes.

Problem sind unsere Kommentarzeichen ( /* */ ), bei unserer Sprache gibt es leider keine Ausweichmöglichkeit wie zB bei C / C++ ( // statt /* ),

deswegen haben wir ( noch ) keine Lösung dafür.

Sollte ich den von Dir angemerkten Punkt auch im Antrag schreiben, oder dann nur in der Doku umsetzen ?

Vielen Dank für Deine Antwort!

[metux]

Doxygen geht leider nicht bei unserer Programmiersprache (Progress..).

Angeblich könnte Doxygen es zwar lernen, aber die Firma möchte lieber etwas eigenes.

Was spricht denn dagegen, Doxygen entsprechend auszubauen ?

Problem sind unsere Kommentarzeichen ( /* */ ), bei unserer Sprache gibt es leider keine Ausweichmöglichkeit wie zB bei C / C++ ( // statt /* ),

deswegen haben wir ( noch ) keine Lösung dafür.

Wäre mir neu, daß doxygen damit Probleme hat ;-o

[Schiller256]

Der Parser selbst ist sicherlich ein Abschlussprojekt aber alles was danach kommt ist in meinen Augen zu dünn für ein FIAE Projekt. Deine Aufgabe wäre es ja nun das fertig XML Dokument in euer Wiki zu übertragen? Habt ihr da ein eigenes Wiki geschrieben oder nutzt ihr da eines der vielen Verfügbaren Wiki's? Denn im Moment ist das für mich eine reine XSLT Transformation von der XML Datei die der Parser ausgibt in die entsprechende Wiki Markup. Das ist für einen FIAE zu wenig. Was du mit einem User Interface jetzt noch willst verstehe ich aus deinem Antrag mal gar nicht.

Hinzu kommt das du in deiner Realisierung max. 35 Std. haben solltest der Rest zu deinen 48 Std. sollte in Planung und Doku gehen. Denn ich glaube nicht das du in 8 Std. die Doku für einen FIAE Projekt erstellst.