Tweet
Dokumentations-Modul
Einen wunderschönen Guten Morgen,
wünsche ich euch.
Ich bin Schüler an einem Berufskolleg und heute ist mal wieder ein grässlicher Tag. Jeden Dienstag und Mittwoch findet bei uns ein Projekttag statt.
Das Projekt sieht so aus, dass wir uns als Projektgruppe, bestehend aus jeweils drei IT-Professionals, bei der sog. "Saubermann AG" vorstellen und dem Unternehmen eine IT-Infrastruktur anbieten. Zu dieser Infrastruktur gehört die Konzeption einer sinnvollen Netzwerktopologie und auch der späteren Abdeckung des Schriftverkehrs im Betrieb durch eine von uns programmierte Software. Soviel zum Projekt.
Nun mein Anliegen.
Der komplette Aufbau und die Entwicklung der Software müssen ordentlich dokumentiert werden.
Ich hatte mir nun überlegt eine Art CMS zu programmieren, welches durch Angabe von "Texttypen" und dem gewünschten Inhalt die Daten in eine Datenbank schreibt und hinterher in der richtigen Reihenfolge wieder ausliest.
"Texttypen" wären in dem Fall z.B. Überschriften, Fußzeilen, Kopfzeilen, Inhaltsverzeichnisse, etc.
Die Dokumentation soll in einem Browserfenster anzuschauen sein, wobei der Denkanstoß, welcher mich dazu angeregt hat solch ein Dokumentationsmodul zu schreiben, eher der war, dass es seit neuerdings die Möglichkeit gibt duch eine PHP Library *.doc Dokumente zu generieren.
Mein Problem bei der ganzen Sache ist, dass meine Gehirnwindungen mir noch einige Steine in den Weg werfen, was das abstrakte Denken angeht und somit mir die Konzeption schwer fällt.
Sollte ich hierfür eine class doc { ... } programmieren?
Was für Eigenschaften kann solch eine Klasse aufweisen, die vllt. jetzt auf den ersten Blick nicht ersichtlich sind?
Wie lege ich am Besten fest, um welche Art von "Texttyp" es sich nun handelt? Sinnvoll wäre es auch diese Texttypen von Stil her editieren zu können.
Und wie kennzeichne ich den Inhalt, so dass er hinterher in der richtigen Reihenfolge dargestellt wird?
Wie würde auch beispielsweise solch eine Funktion aussehen, die eine Textpassage mit all den festgelegten Eigeschaften formatiert? Sollte ich Templates verwenden? ( wobei ich erwähnen muss, dass ich bisher noch nie mit Templates gearbeitet habe )
Wie ihr seht, fällt mir das Ganze nicht sehr leicht.
Ich erwarte auch nicht, dass wirklich jede Frage beantwortet wird.
Ich hoffe nur auf einige Ansätze euererseits.
Gruß,
Jarek
wünsche ich euch.
Ich bin Schüler an einem Berufskolleg und heute ist mal wieder ein grässlicher Tag. Jeden Dienstag und Mittwoch findet bei uns ein Projekttag statt.
Das Projekt sieht so aus, dass wir uns als Projektgruppe, bestehend aus jeweils drei IT-Professionals, bei der sog. "Saubermann AG" vorstellen und dem Unternehmen eine IT-Infrastruktur anbieten. Zu dieser Infrastruktur gehört die Konzeption einer sinnvollen Netzwerktopologie und auch der späteren Abdeckung des Schriftverkehrs im Betrieb durch eine von uns programmierte Software. Soviel zum Projekt.
Nun mein Anliegen.
Der komplette Aufbau und die Entwicklung der Software müssen ordentlich dokumentiert werden.
Ich hatte mir nun überlegt eine Art CMS zu programmieren, welches durch Angabe von "Texttypen" und dem gewünschten Inhalt die Daten in eine Datenbank schreibt und hinterher in der richtigen Reihenfolge wieder ausliest.
"Texttypen" wären in dem Fall z.B. Überschriften, Fußzeilen, Kopfzeilen, Inhaltsverzeichnisse, etc.
Die Dokumentation soll in einem Browserfenster anzuschauen sein, wobei der Denkanstoß, welcher mich dazu angeregt hat solch ein Dokumentationsmodul zu schreiben, eher der war, dass es seit neuerdings die Möglichkeit gibt duch eine PHP Library *.doc Dokumente zu generieren.
Mein Problem bei der ganzen Sache ist, dass meine Gehirnwindungen mir noch einige Steine in den Weg werfen, was das abstrakte Denken angeht und somit mir die Konzeption schwer fällt.
Sollte ich hierfür eine class doc { ... } programmieren?
Was für Eigenschaften kann solch eine Klasse aufweisen, die vllt. jetzt auf den ersten Blick nicht ersichtlich sind?
Wie lege ich am Besten fest, um welche Art von "Texttyp" es sich nun handelt? Sinnvoll wäre es auch diese Texttypen von Stil her editieren zu können.
Und wie kennzeichne ich den Inhalt, so dass er hinterher in der richtigen Reihenfolge dargestellt wird?
Wie würde auch beispielsweise solch eine Funktion aussehen, die eine Textpassage mit all den festgelegten Eigeschaften formatiert? Sollte ich Templates verwenden? ( wobei ich erwähnen muss, dass ich bisher noch nie mit Templates gearbeitet habe )
Wie ihr seht, fällt mir das Ganze nicht sehr leicht.
Ich erwarte auch nicht, dass wirklich jede Frage beantwortet wird.
Ich hoffe nur auf einige Ansätze euererseits.
Gruß,
Jarek