[schifti]

Hi Leute,

ich bin schon ziemlich am Ende meines Abschlussprojektes und habe auch fast die Dokumentation fertig (Quellen & Links müssen noch angepasst werden.).

Falls mal jemand Zeit und Lust hat sich meine Dokumentation anzuschauen und nach Verbesserungsmöglichkeiten zu suchen, würde ich mich freuen.
dokumentation.zip (669,3KB)



Kennt vielleicht jemand auch ein Programm (Free- oder Shareware) zum erstellen von Struktogrammen (Suse 10 oder XP)?


P.S. das mit dem ERM und mit dem Struktogramme, ist echt Schei....., das muss ich noch überarbeiten.


Schon mal an alle ein fettes Dankeschön für eure Mühe!

[robo47]

soweit ich weis konnte Visio strukogramme erstellen, ich habs allerdings im neuen MS Visio nicht mehr gefunden, naja wurde halt aufgekauft von MS.

ansonsten gibts: http://www.strukted.de/ etwas komische bedienung.

zur doku:

2.2
-> "x-beliebige" klingt irgendwie nicht gut für ein doku
2.3
"Der Projektverantwortliche, welcher das Projekt auf mich übertragen hat," klingt auch komisch

3.1
"nach folgende" schreibt man das ned zusammen ?

5.7.1
Das Quelltextbild würd ich lieber nochmal ein besseres bild machen im ersten moment dachte ich, du hättest in dem if/else [] verwenden es ist kaum ersichtlich dass es sich um {} handelt.

7.4.2
ctype ist doch nicht für c-sachen sondern überprüfung von zeichenketten, z.b. ob sie nur aus zahlen oder so bestehen.
filepro ist eigentlich nicht für das bearbeiten von dateien, sondern filepro ist ne datenbank
gettext ist zur übersetzung von texten soweit ich weis
mbstring sind multybyte-funktionen für das arbeiten mit strings die aus anderen zeichensätzen sind

joa das wäre so das was mir beim drüberschauen aufgefallen wäre.


mfg
robo47

[WarrenFaith]

Was ich gefunden habe:

Sorry aber du brauchst dringend Formatierungsrichtlinien:
- Mach keine 10 Neuzeilen um auf ne neue Seite zu kommen
- mach den gleichen Freiraum über den Überschriften (nicht mal 2 und dann mal 4) und eher weniger als zuviel. 3/4 Zeilen sind meiner Meinung nach zuviel...
- Blockausrichtung von Texten würde ich bevorzugen (musst du sehen wie es aussieht)
- generelle Einigung wie Auflistungen (Stichpunkte) gestaltet werden (mal Punkte, mal dreieckige Pfeile...)

---------------------------------

Nun mal detailierter:

1. Einleitung:
- Ich würd dort noch kurz auf den Grund des Berichts eingehen. (Abschlussprüfung für die Ausbildung)

2.2.
- siehe robo47 (x-beliebig, vllt besser: "registrierte User mit spezifischen Rechten")

3.1
- Gesprächsnotiz: "nachfolgende" zusammengeschrieben

3.2
- 1. und 2. Satz: 2x "somit" besser umformulieren
- "ungeprüfte Verarbeitung von Daten des User" -> "ungeprüfte Verarbeitung von Eingabedaten" ?

4.4.2
- blaue Tabelle? mich erschlägts irgendwie (ausgedruckt sieht es bestimmt auch nicht gut aus)

4.6 & 4.6.1
- Einrückung der Überschrift ist nicht gleich
- "Der Kapazitätsplan zeigt, welche Ressourcen [mir] für das Projekt zur Verfügung standen und welche Ressourcen [ich] benötigte." -> Berichte lieber unpersönlich verfassen
- wuho was für Stichpunktstriche unter 4.6.1

4.7
- Da fehlt ein Satzpunkt und Klammern möglichst vermeiden (mein Dozent meinte immer, was in Klammern steht wird nicht gelesen)

5.1
- "Als „Desktop-Oberfläche“, wurde der Text-Modus gewählt, da auf dem LAMP-System nicht grafisch gearbeitet werden muss und so vermieden wird unnötigen Ballast mit zu installieren auf diese Weise werden Speicherplatz und andere Systemressourcen gespart." -> mach mal 2 oder 3 Sätze daraus "Als „Desktop-Oberfläche“ wurde der Text-Modus gewählt, da auf dem LAMP-System nicht grafisch gearbeitet werden muss. Somit wird vermieden, dass unnötige Softwarepakete installiert werden. Neben dem Spareffekt für Systemressourcen wird auch eventuellen Sicherheitsmängel unnötiger Software vorgebeugt." (als Beispiel)

5.2
- Postfix und Runlevel fehlen im Glossar
- Erklärung was Runlevel 2 bedeutet

5.4
- "safe_mod wurde nicht aktiviert, da dies zu zeitaufwendig wäre, ist aber auf einem produktiven System zu empfehlen, damit gefährliche Funktionen und Einstellungen deaktiviert sind.
Genauso wie sich auch das „Hardened Projekt“ anzuschauen." -> irgendwie nicht so prickelnd, aber mir fällt grade nix besseres ein
- Erklärungen lieber in Fußnoten packen

5.5
- "Die Authentifizierung, wurde auf „config“ gelassen, aber das Verzeichnis wurde mit .htaccess passwortgeschützt." erstes Komma weg

5.6
- "Programmieren des Logins die Dateien und Ihre Aufgaben:
Erstellen der:" -> "Programmieren des Logins" ist doppelt (steht direkt drüber in der Überschrift) und 2 Doppelpunkte hintereinander ist auch nicht empfehlenswert

5.7
- Einrückung der Beschreibung ist nicht wie in 5.6

5.8
- "... Überprüfungen validiert wurden.." 2 Satzpunkte
- "Der einzigste Fehler, der aber mit dieser Datenbankstruktur nicht lösbar ist, ist das man maximal einmal eingeloggt sein kann, also nur mit einem Browser-Fenster." -> Sicher? Tabbrowsing erlaubt sicher auch 2+ Fenster (Session-ID bleibt ja gleich...)

6.1.2 & 6.1.3
- sind falsch eingerückt

ANHANG:
Sollzustand: -> Software (Kommas entfernen in der Liste)
Quellen: -> eine ISBN zum Buch fehlt noch


7.1 Glossar
-> Beschreibungen zu Abkürzungen: Ich würde die Buchstaben, die für die Abkürzung benutzt werden Fett hervorheben und nicht groß schreiben (Database z.B), sonst ist vielleicht noch ein Rechtschreibfehler

-------------------------
so ich hab jetzt ne Stunde das durchgelesen. Im großen und ganzen sehr gut, nur deine Kommasetzung und die Formatierung der Texte/Überschriften sollte dringend überarbeitet werden (vor allem wenn du das als DOC abgeben muss, als PDF reicht es, wenn der Abstand einheitlich ist)

[schifti]

Vielen, vielen Dank für eure Mühe.

Ich habe die Doku (alter Stand) mal als pdf erstellt.

Ich habe heute "Bewerbungstraining" und muss los.

noch mal vielen Dank.

[robo47]

Dann viel Glück

[schifti]

Zitat von WarrenFaith

Sorry aber du brauchst dringend Formatierungsrichtlinien:
- Mach keine 10 Neuzeilen um auf ne neue Seite zu kommen
- mach den gleichen Freiraum über den Überschriften (nicht mal 2 und dann mal 4) und eher weniger als zuviel. 3/4 Zeilen sind meiner Meinung nach zuviel...
- Blockausrichtung von Texten würde ich bevorzugen (musst du sehen wie es aussieht)
- generelle Einigung wie Auflistungen (Stichpunkte) gestaltet werden (mal Punkte, mal dreieckige Pfeile...)

Also, bei den Seiten habe ich überall einen manuellen Umbruch gemacht,
bei den Überschriften siehts jetzt so aus:

2. Phase
<br> x 3 (12pt)
2.1 Überschrift
<br> x 1 (10pt)
Text
<br> x 3 (12pt)
2.2 Überschrift
<br> x 1 (10pt)
Text
<br> x 4 (12pt)
3. Phase..

Einheitliche Stichpunkte sinds nun auch.
Andere Bilder beim QT,

Die Farben bei dem Gantt-Diagramm lasse ich so, sieht ausgedruckt viel besser aus.

Also, falls noch mal jemand drüber schauen möchte:
dokumentation.zip (354,3 KB, inkl. pdf)
dokumentation.zip (254,8 KB)

[edit]
Uppps, die Zahlen der Links auf Seite 2 [x] sind jetzt auch eingetragen, aber nicht in der Online Version!