superbaguss Geschrieben 16. Mai 2004 Geschrieben 16. Mai 2004 ahoi, ich habe meine doku fertig, könntet ihr einen blick drauf werfen, und kritik spenden? http://www.malte-eismann.de/projektdokumentation-malte-eismann.pdf Zitieren
Umbratus Geschrieben 17. Mai 2004 Geschrieben 17. Mai 2004 ahoi, ich habe meine doku fertig, könntet ihr einen blick drauf werfen, und kritik spenden? 1. Person Singular sollte man vermeiden, das soll keine Prosa sein sondern eine technische Dokumentation. Am besten in Präsens schreiben. Bei dir wechselt es alle zwei Sätze zwischen Gegenwart und Vergangenheit. Zitieren
Commandor Geschrieben 17. Mai 2004 Geschrieben 17. Mai 2004 Hi! Den Tipp von Umbratus solltest Du sehr ernst nehmen. Da ich leider nicht die Zeit dazu habe mir die Dokumentation durchzulesen bin ich die nur kurz überflogen und zähle mal evtl. Fehler auf: 2.2 Soll-Analyse -> Soll-Konzept (Es gibt keine Soll-Analyse!) Wo sind Screenshots? Mehr finde ich gerade nicht *g* Ciao cdr Zitieren
superbaguss Geschrieben 17. Mai 2004 Autor Geschrieben 17. Mai 2004 Am besten in Präsens schreiben. Bei dir wechselt es alle zwei Sätze zwischen Gegenwart und Vergangenheit. Zitieren
superbaguss Geschrieben 17. Mai 2004 Autor Geschrieben 17. Mai 2004 you wrote: Wo sind Screenshots? consolenscreenshots? Zitieren
Commandor Geschrieben 17. Mai 2004 Geschrieben 17. Mai 2004 you wrote: Wo sind Screenshots? consolenscreenshots? Nicht so ernst nehmen hab das nur kurz überflogen, dachte dort werden Windows Clients installiert (Hab mir nur kurz die Grafik angesehen) Deswegen in der einen Grafik auch Client auf Server ändern (Hab mir erst jetzt die IST-Analyse durchgelesen.) Mfg Zitieren
Umbratus Geschrieben 17. Mai 2004 Geschrieben 17. Mai 2004 die technische seite ist nicht in der ich-form be- oder geschrieben, lediglich die teile, in denen ICH auf MEIN projekt eingehe, und da finde ich es angebracht. Sorry, aber das ist keinesfalls angebracht. Die Ich-Form wirkt sehr stümperhaft, wenn du noch die Zeit hast würde ich dir dringend raten alles Ichs zu entfernen. Ich setz mal diesen Satz noch als Negativ-Beispiel in Sachen Zeiten und Ich-Form: "Nach ausgiebiger Testphase implementierte ich den Server Im Rechenzentrum mit Herrn Wiebe, der für die Infrastruktur der Server zuständig ist." Klingt furchtbar findest du nicht ? Zitieren
superbaguss Geschrieben 17. Mai 2004 Autor Geschrieben 17. Mai 2004 Nicht so ernst nehmen hab das nur kurz überflogen, dachte dort werden Windows Clients installiert (Hab mir nur kurz die Grafik angesehen) Deswegen in der einen Grafik auch Client auf Server ändern (Hab mir erst jetzt die IST-Analyse durchgelesen.) Mfg no worries, bin für jede kritik dankbar. malte Zitieren
MBaeuml Geschrieben 17. Mai 2004 Geschrieben 17. Mai 2004 hört sich Stellenweise echt an wie mein schönstes Ferienerlebnis. Also Ich-Form raus. Ansonsten würde ich das Layout am Ende noch mal kontrollieren, z.B. das Glossar auf eine eigene Seite, also danach Seitenumbruch, da war der nächste Punkt noch halb mit drauf auf der Seite. Zitieren
superbaguss Geschrieben 17. Mai 2004 Autor Geschrieben 17. Mai 2004 hört sich Stellenweise echt an wie mein schönstes Ferienerlebnis. Also Ich-Form raus. ok, hier scheinen ja alle auf die IKKE-Form allergisch zu reagieren, dann schmeiss ichs jetzt raus. morgen früh lad ich die neue version auf den server. danke für die hilfe, malte Zitieren
Doham Geschrieben 17. Mai 2004 Geschrieben 17. Mai 2004 Ich hab die Doku nur mal kurz überflogen, deshalb von mir nur ein paar Kommentare zum Layout: 1.) Ist die Schriftfamilie vorgeschrieben? Wenn nicht, dann würde ich wegen der besseren Lesbarkeit dringend zu einer Schrift mit Serifen wie Times New Roman o.ä. raten. 2.) Deine Gliederung a) IMHO gehören Unterpunkte wie 2.1 nicht eingerückt. vgl. "Handbuch zur Abschlussprüfung IT-Berufe, Winklers Verlag" Ich finde dass Du zu viele Punkte in deiner Gliederung hast. Für fast jeden Absatz hast Du einen Punkt in der Gliederung. Versuche doch mal einige Punkte deiner Dokumentation unter einer Überschrift zusammen zufassen. IMHO sollten nicht mehr als 3 Überschriften pro Zeile zu sehen sein. 3.) Absatzformatierung Sieh dir mal bei 3.3 die formatierung an. Sollen die Zeilen wirklich links eingerückt sein? Fazit: In deinem Layout stecken noch einige Verbesserungsmöglichkeiten - Nütze sie. Zitieren
superbaguss Geschrieben 18. Mai 2004 Autor Geschrieben 18. Mai 2004 Ich hab die Doku nur mal kurz überflogen, deshalb von mir nur ein paar Kommentare zum Layout: 1.) Ist die Schriftfamilie vorgeschrieben? Wenn nicht, dann würde ich wegen der besseren Lesbarkeit dringend zu einer Schrift mit Serifen wie Times New Roman o.ä. raten. 2.) Deine Gliederung a) IMHO gehören Unterpunkte wie 2.1 nicht eingerückt. vgl. "Handbuch zur Abschlussprüfung IT-Berufe, Winklers Verlag" Ich finde dass Du zu viele Punkte in deiner Gliederung hast. Für fast jeden Absatz hast Du einen Punkt in der Gliederung. Versuche doch mal einige Punkte deiner Dokumentation unter einer Überschrift zusammen zufassen. IMHO sollten nicht mehr als 3 Überschriften pro Zeile zu sehen sein. 3.) Absatzformatierung Sieh dir mal bei 3.3 die formatierung an. Sollen die Zeilen wirklich links eingerückt sein? Fazit: In deinem Layout stecken noch einige Verbesserungsmöglichkeiten - Nütze sie. also...schrift: ohne serifen vorgeschrieben, das mag ich auch lieber. eingerückte unterpunkte: das macht was her, das kann auch der winklers verlag anders sehen, das vertrete ich gern. zu viele punkte: ok es sind eine menge, aber das projekt ist auch recht komplex, das schafft doch eher übersichtlichkeit? was meinst du mit 3 überschriften pro zeile? 3.3 eingerückt: dient zur unterscheidung der einzelnen Punkte. eine Auflistung war selbst mir dem "unterpunkt-Man" zuviel. Zitieren
superbaguss Geschrieben 18. Mai 2004 Autor Geschrieben 18. Mai 2004 Die überarbeitete Version ist jetzt online, hoffe ihr habt die kraft euch das nochmal reinzuziehen. danke im Voraus, der malte http://www.malte-eismann.de/projektdokumentation-malte-eismann.pdf Zitieren
Umbratus Geschrieben 18. Mai 2004 Geschrieben 18. Mai 2004 [Edit] Sind noch 6 oder 7 ichs drin. An den Zeiten hast du auch nicht viel gemacht. "Das Praktikum fand im ... statt, dort arbeiten zur Zeit...." Zitieren
superbaguss Geschrieben 18. Mai 2004 Autor Geschrieben 18. Mai 2004 *ähä*, werd das mal gegenlesen lassen und verbessern...das is wohl nich so mein ding. sag bescheid wenns fertig ist, dank dir trotzdem. weitere verbeserungsvorschläge trotzdem gerne. malte Zitieren
hmaas Geschrieben 18. Mai 2004 Geschrieben 18. Mai 2004 Die überarbeitete Version ist jetzt online, hoffe ihr habt die kraft euch das nochmal reinzuziehen. 4.2 Inbetriebnahme des Installationsservers Der Installationsserver wird von den aktuellsten Quellen aus dem Internet mit Hilfe von Bootdisketten installiert. Dabei ist die unter 2.2 beschriebene Methode zum Einsatz gekommen, Quelle ist der RedHat-FTP-Server (Internet). Eine zuvor erstellte ks.cfg mit Minimalkonfiguration der Pakete ist benutzt worden. Partitioniert habe ich den Server in vier Partitionen: /swap , / , /boot und /data. Nach dem Reboot des Servers mussten noch Einträge in die /etc/resolv.conf vorgenommen werden, ein Benutzer malte angelegt und dann die Installationspakete vom RedHat-FTP-Server mit ncftp auf die /data Partition gespiegelt werden. Ist nur ein Beispiel aus vielen, der Absatz springt in den Zeiten, wechselt die Person und hat ein Wort welches garnicht in den Kontext passt. Zudem sprichst du manchmal deinen Prüfungsausschuß mit Sie an. Finde ich sehr merkwürdig, schreib das ganze Personenneutral, wie in der ersten Zeile des Zitats. (Wenn du "Sie" benutzt, dann bitte groß schreiben). Du benutzt eine sehr allgemeine Sprache: knifflig, gefahndet (7.1) ist mir aber auch schon früher aufgefallen. Bei 1.3 Zeitplanung des Projektes ist in der Tabelle augentscheinlich eine wechselnde Schriftgröße zu erkennen. Die geforderten Rahmenbedingungen konnten in der vorgegebenen Zeit nicht ganz erfüllt worden. Daher ist die Implementierung der Firewall aus meinem Projekt gestrichen worden und hier nur kurz angeführt. Vorher war erkennbar, das das den Projektrahmen von 35 Stunden sprengen würde. Bitte, du weißt vorher das du es nicht schaftst und planst es trotzdem???? Naja bin jetzt nur drüber geflogen... Gruß Pönk Zitieren
superbaguss Geschrieben 18. Mai 2004 Autor Geschrieben 18. Mai 2004 tabelle: stimmt. prüfungsausschuss: wo? alllgemeine sprache: belebt das staubtrockene dokument wie rätst du mir mit der firewallplanung umzugehen? danke, malte Zitieren
Umbratus Geschrieben 18. Mai 2004 Geschrieben 18. Mai 2004 "Vorher war erkennbar, das das den Projektrahmen von 35 Stunden sprengen würde." Na wie wärs wenn du dir diesen Satz einfach sparst. Ist das nicht naheliegend für dich ? Zitieren
Sandrin Geschrieben 18. Mai 2004 Geschrieben 18. Mai 2004 alllgemeine sprache: belebt das staubtrockene dokument Fachliche Dokumentationen sollten auf gar keinen Fall durch Umgangssprache belebt werden. Das wirkt unproffesionell. Zitieren
hmaas Geschrieben 18. Mai 2004 Geschrieben 18. Mai 2004 prüfungsausschuss: wo? z.B.: Umfangreiche Informationen zum Netboot-Prozess bekommen Sie aus dem Developer-Manual des Etherboot-Projektes unter http://etherboot.sourceforge.net/doc/html/devman/extension.html Mit rpm -ivh /data/RedHat/dhcp-3.0 wird der DHCP-Server installiert. Die Konfigurationsdatei /etc/dhcpd.conf muss auf die Gegebenheiten angepasst werden, die fertige dhcpd.conf finden sie im Anhang. Weitere Informationen entnehmen Sie bitte der fstab und der /etc/vsftpd/vsftpd.conf im Anhang, sowie der Projektseite http://vsftpd.beasts.org/. Das Programm finden Sie im Anhang, weitere Informationen auf der Syslinux-Projektseite http://syslinux.zytor.com/. Rechtschreibfehler: Das Vorhandensein einer Technische Besonderheiten, die aufgrund der Freiheit entanden sind, die bei der Implementation gewährt wurde, sind geklärt worden (Pfadangaben, Mirror-update, Webinterface). Naja das find ich zum Schluß noch wichtig: Die wirtschaftliche Komponente des Installations-Servers liegt auf der Hand, jetzt kann sogar Herr Wiebe (Team Serverinfrastruktur) mit wenigen Handgriffen einen neuen Kundenserver einrichten und dem Unix-Team fertig installiert zur Verfügung stellen. Wenn ich Herr Wiebe wäre würde ich dich nicht mehr mögen, du unterstellst im totale Inkompetenz. Gruß Pönk Zitieren
superbaguss Geschrieben 22. Mai 2004 Autor Geschrieben 22. Mai 2004 Hallo,danke an alle, die mich hier unterstützt haben, ich habe die dokumentation gerade zur ihk hochgeladen. den final release lege ich im verlauf des tages auf meinen webserver. so long, der malte Zitieren
superbaguss Geschrieben 14. Juni 2004 Autor Geschrieben 14. Juni 2004 hallo zusammen, ich hatte am freitag 11.6. meine präsentation. ertmal vorweg, passend zum thread: miene dokumentation hat mir eine drei eingebracht, da sie so schwer zu lesen ist. etwas einfacher und lockerer hätte auch ausgereicht. der anhang sei zu ausführlich, scriptausschnitte wären wohl genug gewesen, ebenso konfigurationsdateien. prüfablaufprotokolle haben gefehlt. UND JETZT FÜR ALLE ICH-VERNEINER: ICH's können sehr wohl vorkommen, zumindest in berlin! schliesslich ist die dokumentation für die prüfungskommission, die sich ausschliesslcih auf das von mir durchgeführte projekt bezieht!! so long, der malte Zitieren
Umbratus Geschrieben 15. Juni 2004 Geschrieben 15. Juni 2004 der anhang sei zu ausführlich, scriptausschnitte wären wohl genug gewesen, ebenso konfigurationsdateien. Das sollten mal alle "Man-muss-40-Seiten-Source-anhängen-Verfechter" beachten. Die Sache mit der Ich-Form is ja interessant. Bin mir sicher dass bei uns in Baden-Württemberg sowas massiv Punktabzug gibt. Zitieren
Empfohlene Beiträge
Dein Kommentar
Du kannst jetzt schreiben und Dich später registrieren. Wenn Du ein Konto hast, melde Dich jetzt an, um unter Deinem Benutzernamen zu schreiben.