Version 2, last updated by Kirsten at July 03, 2007 20:59 UTC
Dokumentation
Da es ja einige verwirrungen in Sachen Dokumentation gab/gibt,
mache ich hier mal ne Seite, wo wir unsere Doku planen können.
Es ist dann auch leichter nacher die HTML-Seiten entsprechend zu planenen,
ohne die ständig wieder umbauen zu müssen.
Zuerst ein paar allgeimeine Fragen:
a) Wird das ganze Projekt eingenlich wirlich online gestellt und angeboten?
b) Dürfen wir die Javadoc noch auf "schön" überarbeiten?
So jetzt wäre noch schön, wenn da jeder seinen Senf dazugeben würde
am besten in unterschiedlichen Farben, so dass man die Leute auseinander halten kann.
Am besten so, dass bis Freitan eine "Final-Version" für das Konzept entsteht,
so dass wir dann lam Wochenende endlich loslegen können.
Wäre auch nett, wenn sich die Betreuer noch mal zum Doku-Konzept äußern könnten.
1) Also als erste mal eine Willkommensseite, mit einem kurzen Überblick und dann eine Verlinkung mit kurzer Beschreibung auf die restlichen Seiten Name: index.htm
2) Introduction.htm
wo es dann eine allgemeine Beschreinbung des Programmes gibt,
mit Hintergund, warum wir das überhaupt gemacht haben
evt. noch sagen, dass es halt ein Progrmmierprojekt von der Uni aus ist
3) also das getStarded, weiß ich gerade selber nicht, was ich darunter verstehen soll
4) Obtaining and Installing
also wir können gerne noch eine Seite einrichten namens : download.htm
wo man das Progrämmchen dann herbekommt
aber das installing sollten dann die Betreuer schreiben,
denn da wissen wir ja nicht bescheid und wir haben es ja auch nicht gemacht
5) programm overview
würde ich eher als "first stepps" oder so was ansehen,
wo man dann die Grundlagen des Programms erklärt,
also wie man eine Datei läd, was ich für Optionen habe, etc
Dort kann man dann auch noch weiter verlinken, auf spezielle Seiten,
zB. was für files kann ich laden, wo sind die gespeichert, wo bekomme ich die her,
was für ein Format sollten die haben
6) internel sites
also hier würde ich schon nach Gui, Vis und IO unterteilen,
wo dann halt noch mal jeder seine speziellen Funktionen/Features erklärt,
mit entspechenden Verlinkungen auf die first_stepps.htm
7) javadocs.htm
soll es da eigenlich eine gemeinesame Javadoc geben, oder in die 3 Gruppen unterteilt?
8) download.htm
Nach Windows und Linux unterscheiden
siehe oben
9) impressum.htm
oder direkt in die untere spalte schreiben?
Was soll da eigentlich alles rein?
Was für eine e-mail / Kontaktadresse soll da überhaupt rein?
mache ich hier mal ne Seite, wo wir unsere Doku planen können.
Es ist dann auch leichter nacher die HTML-Seiten entsprechend zu planenen,
ohne die ständig wieder umbauen zu müssen.
Zuerst ein paar allgeimeine Fragen:
a) Wird das ganze Projekt eingenlich wirlich online gestellt und angeboten?
b) Dürfen wir die Javadoc noch auf "schön" überarbeiten?
So jetzt wäre noch schön, wenn da jeder seinen Senf dazugeben würde
am besten in unterschiedlichen Farben, so dass man die Leute auseinander halten kann.
Am besten so, dass bis Freitan eine "Final-Version" für das Konzept entsteht,
so dass wir dann lam Wochenende endlich loslegen können.
Wäre auch nett, wenn sich die Betreuer noch mal zum Doku-Konzept äußern könnten.
1) Also als erste mal eine Willkommensseite, mit einem kurzen Überblick und dann eine Verlinkung mit kurzer Beschreibung auf die restlichen Seiten Name: index.htm
2) Introduction.htm
wo es dann eine allgemeine Beschreinbung des Programmes gibt,
mit Hintergund, warum wir das überhaupt gemacht haben
evt. noch sagen, dass es halt ein Progrmmierprojekt von der Uni aus ist
3) also das getStarded, weiß ich gerade selber nicht, was ich darunter verstehen soll
4) Obtaining and Installing
also wir können gerne noch eine Seite einrichten namens : download.htm
wo man das Progrämmchen dann herbekommt
aber das installing sollten dann die Betreuer schreiben,
denn da wissen wir ja nicht bescheid und wir haben es ja auch nicht gemacht
5) programm overview
würde ich eher als "first stepps" oder so was ansehen,
wo man dann die Grundlagen des Programms erklärt,
also wie man eine Datei läd, was ich für Optionen habe, etc
Dort kann man dann auch noch weiter verlinken, auf spezielle Seiten,
zB. was für files kann ich laden, wo sind die gespeichert, wo bekomme ich die her,
was für ein Format sollten die haben
6) internel sites
also hier würde ich schon nach Gui, Vis und IO unterteilen,
wo dann halt noch mal jeder seine speziellen Funktionen/Features erklärt,
mit entspechenden Verlinkungen auf die first_stepps.htm
7) javadocs.htm
soll es da eigenlich eine gemeinesame Javadoc geben, oder in die 3 Gruppen unterteilt?
8) download.htm
Nach Windows und Linux unterscheiden
siehe oben
9) impressum.htm
oder direkt in die untere spalte schreiben?
Was soll da eigentlich alles rein?
Was für eine e-mail / Kontaktadresse soll da überhaupt rein?