Wie erstelle ich eine Beschreibung meiner Website 40 Seiten

Hallo liebe Communtiy!

Also ich besuche die Abendschule und habe momentan das Fach Webdesign. Nun muss ich ein Buch darüber schreiben (über meine Webiste ) 40 Seiten ungefähr wie die Website aufgebaut ist.

Kennt wer ne Seite wo man sich so etwas mal ansehen kann wie man so etwas aufbaut? Oder kann von euch einer Tipps geben wie man dort am besten ran geht?

Ist die Matura-Arbeit und unsere Prüfer dürfen uns die alten Bücher nicht zeigen und haben uns nie richtig erklärt wie man so etwas richtig aufbaut.


Jede Hilfe ist herzlich Willkommen.


Dominik

Also ne Dokumentation. Du musst so schreiben, dass ein neuer Webmaster da nach der Dokumentation weiterarbeiten kann.
Hauptaspekte: Nachvollziehbarkeit und Lernbarkeit
Index
Beschreibung der Seite und des Angebots
Technische Aspekte (Hardware, Dienste, Webserver)
Dokumentenstruktur
Layout
Codebeschreibung
hervorhebung von besonderheiten, also speziellen scripten, anwendungen usw. usf.
Sicherheitsmerkmale

Prüfer stehn tierisch auf Diagramme. Damit kriegst du auch mit wenig Arbeit viele Seiten voll und hast dennoch massive Informationen untergebracht.
Ablaufdiagrame, Zustandsübergänge usw. usf.

Das ganze seriös und sachlich halten. Keine bunten Gimmicks einbaun. Die Entwürfe gibste dann jemanden zu lesen der deine Seite nicht kennt, aber technisch versiert ist. Der muss am Ende sagen:" Jau, jetzt gib mir noch die ftp daten und ich kann weiterarbeiten wenn du ausversehn in einen Vulkan fällst"

Dann suchste dir noch jemanden der keine Ahnung von der Materie hat und der muss am Ende sagen:"Jau, ich kapier zwar nicht den Code, aber worum es überhaupt geht, das hab ich verstanden"


40 Seiten ist verdammt heftig. Ich hab für mein Abschlussprojekt in der Fachinformatiker Ausbildung 10 Seiten schreiben müßen und hab gekämpft die vollzukriegen. Also bau ruhig auch Code mit ein den du sauber beschreibst.

Hey super, GROßES DANKE für die Hilfe allein hätte ich nie gewusst wo ich anfange sollte. 40 Seiten ist halt leider so aber in Österreich ist ja alles anders als in Deutschland nicht. Eins noch Schriftgröße 12 oder darf ich des nen bisschen größer machen?

Fang klein an. Nimm 10. Dann guckste wie weit du kommst. Ich hatte damals falsche angaben. Hab mit 10 angefangen und durfte 11. Hach war das herrlich was ein son pünkten an Seitenzahl ausmacht.
Mit der Schriftgröße aber nicht übertreiben. Sonst gibts abzücke in der B-Note fürs Platzschinden.

Kleiner Tip den ich "schmerzhaft" gelernt habe. Schreib erst alles durch. Fließend. Kümmer dich um die Formatierung und das Aussehn erst zum Ende. Sonst bist du nur am Formatieren weil du da was einfügst, da was löscht usw.

Du kannst mir gerne Entwürfe zukommen lassen und schau auch mal drüber.

Ok super, sende dir dann mal nen paar Ausschnitte zu sobald ich einen Teil zusammen habe.

Was mir damals geholfen hat die Dokumentation zu schreiben war eine Mindmap (welche heute noch das White Board in der Firma meiner Ausbildung schmückt... hät mir ja einer sagen können, dass es nen Permanent Marker war )

Mindmap ist relativ einfach. Mal die ne Wolke in die Mitte, schreib Website rein. Und dann verzweigst du von der Wolke in alles was damit zu tun hat. Z.b. Website -> Webserver -> Hardware / Software / Konfig

So schreibst du nicht blindlings los sondern sammelst erstmal was alles dazugehört.

Super Idee, hätte von mir sein können^^. Da hätte ich noch was soll ich auch reinschreiben mit welchen Werkzeug ich dies und jenes gemacht habe?

Das kannst du sicherlich mit angeben aber eher in kurzform mit Grund der Auswahl dieses Tools. Aber nicht zu ausschweifend. Jeder Webdesigner nutzt seine eigenen Sachen. Wichtig ist das er da später einsteigen kann. Anders natürlich bei speziellen Anwendungen, z.b. wenn du nen Anwendungsserver bereitstellst, warum hast du dich da und dafür entschieden. Oder wenn es keine Alternativen gibt und das tool zwingend notwendig ist.

Du musst dir einfach vor Augen halten: Du sitzt in einem Unternehmen und bist für die Website des Kunden verantwortlich. Von heut auf morgen wirst du krank, liegst im Krankenhaus und bist für die Firma nicht mehr zu erreichen. Also wird für teuer Geld ein Ersatzmann rangeholt der sich darum kümmern soll. Entweder er fuchst sich da tage und wochenlang rein um alles zu verstehn oder er nimmt deine Dokumentation. Liest sie einen Tag gründlich und hält das Projekt am laufen.
Natürlich sollte es Option 2 sein im Fall der Fälle

Kleiner moralischer Ausblick etwas off topic. Manche werden dir in der Zukunft vielleicht den "Tipp" zukommen lassen, dass du dich ja unentbehrlich machst wenn du dein Wissen für dich behälst und so einen sicheren Job hast. Da irren sich die Leute. Nen Spezialist knackt deine Passwörter und dein Nachfolger braucht halt 2 Wochen länger, aber dann läuft der Laden ohne dich weiter. Unentbehrlich macht man sich durch inovationen, cleverness und dem Einbringen ins Unternehmen. Wenn du pfiffige Ideen hast auf die keiner kommt.. das macht dich unentbehrlich. Wenn du dann noch dafür sorgst das im Fall der Fälle wo du weg bist solange alles reibungslos läuft. Dann haste alles richtig gemacht.

Wie ich die index Seite Designt habe komme ich auf 2 Seiten kpmplett ausgeschmückt mit allem also nen bisschen verlängert. Soll ich eine Unterseite auch noch beschreiben oder?

Ich würd markante Sachen nehmen. Javascripte, Ajax usw. usf.
Normales HTML würd ich nicht extra definieren.
Eher dann Formate die eingehalten werden müßen. Maße von Grafiken usw.

Also nochmal kann ich das Buche eigentlich so schreiben wie wenn ich einem erklären würde wie er die Website aufbauen soll das macht nichts oder also genau die Schritte was ich gemacht habe?

Du schreibst kein Arbeitsprotokoll sondern eine Dokumentation.
Worauf ist zu achten bei der Seite, Besonderheiten, Extras.
Layout, was ist zu beachten das layout beizubehalten.
Hardware / Software, was wird benötigt um die Webseite zu hosten aka. Datenbanken, Anwendungsserver, Plugins.

Wie eine Anleitung. Dabei interessiert es nicht wo du wann geklickt hast, sondern das dort aus diesem Grund geklickt werden muss.
Generell gehen wir davon aus, dass die Person welche die Dokumentation lesen wird, auf gleichen oder höherem Kentnissstand sein wird wie du. Ausgenommen spezielle besonderheiten. Man kann ja nicht jedes Webplugin kennen.
Technisch gesehn. Inhaltlich wird diese Person deine Website nicht kennen. Du musst nun also ein Dokument verfassen was es jemandem erlaubt dein Projekt übernehmen zu können ohne das du dabei bist und ihm erklärst warum was so ist wie es ist.

Dann bin ich ja eh auf dem richtigen weg super thx. Jetz hab ich auch noch eine Matura per Mail bekommen von nem Freund jetzt gehts rund

Ich hab übrigens ungefähr 2 Wochen an meiner Dokumentation gesessen.

^^ ich hab jetzt schon 7 Seiten für das Screendesgin für Photoshop jetzt kommt dann noch die 2 Seite und dann der Rest mit den Widghets etc. und jetzt hab ich auch endlich meinen Prüfer erreich 25-30 Seiten reichen

Wie gesagt, schick mir ruhig deine Entwürfe, ich zerpflück sie dir dann schon