Struktur der Doku?

[niki]

Hi leute,

ich schreibe zur Zeit meine Doku (FIAE), als hilfsmittel benutze ich das Buch "Abschlussprüfung IT-Berufe". Leider ist bei mir im Betrieb keiner in der Lage mir zu helfen. Es wäre sehr nett, wenn ihr struktur von meiner doku gegenlesen könnten und die meinung dazu sagen. Es handelt um eine Personalverwaltung....

1. Ausgangssituation

1 Das Unternehmen

2 Auftrag und Ziele

3 Projektumfeld und Projektschnittstellen

2. Plannung

1 Terminplanung

2 Kostenplanung

3 Ablaufplan

3 Realisierung

1 Ist-Analyse

2 Soll-konzept

3 Datenbankentwurf

1 Datenanalyse

2 Normalisierung

[just_me]

- Punkt 1.1 ist den einen oder anderen Gedanken in Richtung Reißwolf wert.

- Punkt 1.3 ist irritierend. Was meinst du mit Projektumfeld?

- Punkt 2.3 ist eigentlich Bestandteil des Entwurfs (als eigenem Kapitel).

- Punkt 3.1 ist Bestandteil der Ausgangsituation.

- Punkt 3.2 ist ebenfalls Bestandteil der Ausgangssituation.

(Gilt nur, wenn der Datenbankentwurf nebenläufiger Bestandteil und nicht Kernthema ist.)

- Punkt ? (Datenbankentwurf) ist Bestandteil des Entwurfs.

- Punkt ?.1 (Datenanalyse) ist Bestandteil des (Datenbank)Entwurfs.

- Punkt ?.2 (Normalisierung) ist Bestandteil des (Datenbank)Entwurfs.

Wenn die Entwicklung einer Software Schwerpunkt war/ist/wird, sollte das auch Ausdruck in der Dokumentation finden. Wie wäre es mit einem Punkt Entwurf, in dem du detaillierter auf die Entwurfsphase eingehst?

Das Kapitel "Realisierung" beschäftigt sich mit der Umsetzung von "Planung" und "Entwurf".

Und schließlich fehlt die Schlussfolgerung deiner Betrachtung völlig. Einen Epilog solltest du schon noch einplanen.

[CyberDemon]

Original geschrieben von just_me

- Punkt 1.3 ist irritierend. Was meinst du mit Projektumfeld?

Damit beschreibt man in der Regel seinen Betrieb, die Abteilung und deren Aufgaben.

Bei dem Rest stimme ich dir zu!

[niki]

erstmal danke für vorschläge,

ich hatte probleme mit meiner verbidung gehabt, deswegen denke ich mal wurde die hälfte von meinem beitrag verschluckt.

@CyberDemon

Mit Projektumfeld hast du Recht. Da beschreibe ich noch die Entwicklungsumbegung.

Damit es verständlicher wird füge ich mein verzeichnis nochmal bei:

1 Ausgangssituation

-1.1 Das Unternehmen

-1.2 Auftrag und Ziele

-1.3 Projektumfeld und Projektschnittstellen

2 Plannung

-2.1 Terminplanung

-2.2 Kostenplanung

-2.3 Ablaufplan

3 Realisierung

-3.1 Ist-Analyse

-3.2 Soll-konzept

-3.3 Datenbankentwurf

-3.3.1 Datenanalyse

-3.3.2 Normalisierung

-3.3.3 ERM

-3.3.4 Anlegen der Datenbank

-3.4 Entwurf von Formularen

-3.5 Programmieren von Funktionen

-3.6 Einbinden von Funktionen

-3.7 Programmtest und Fehlerkorrektur

-3.8 Installation und Anweisung

4 Projektergebnis

-4.1 Soll-Ist Vergleich

-4.2 Fazit

@ just_me

Ich denke dass diese struktur verständlicher wird

[just_me]

Wie ich oben bereits erwähnte:

1.1 ... Ist das wirklich notwendig?

1.2 Das ist heikel. Wenn die Ziele nicht sehr umfangreich sind, könnten sie in das SOLL einfließen. Und ist der "Auftrag" nicht identisch mit dem SOLL?

3.1 nach 1

3.2 dito

3.3 in das (neue) Kapitel "Entwurf" (außer 3.3.4 eventuell)

3.4 dito

Hint: Deine Ausgangssituation bläht sich gewaltig auf. Der Fokus könnte dabei vom eigentlichen Schwerpunkt verrutschen, falls dieser auf der Realisierung lag ...

[niki]

hi

also punkt 1.1 werde ich lassen(steht so in manchen bücher)

ansonsten hatte ich umstrukturiert:

1 Ausgangssituation

-1.1 Das Unternehmen

-1.2 Ist-Analyse

-1.3 Soll-konzept

-1.4 Projektumfeld und Projektschnittstellen

2 Ressourcen- und Ablaufplanung

-2.1 Terminplanung

-2.2 Kostenplanung

-2.3 Ablaufplan

3 Entwurf

-3.1 Datenbankentwurf

-3.1.1 Normalisierung

-3.1.2 ERM

-3.2 Entwurf von Formularen

4 Realisierung

-4.1 Anlegen der Datenbank

-4.2 Anlegen der Formulare

-4.3 Programmieren von funktionen

-4.4 Einbinden von Funktionen

-4.5 Programmtest und Fehlerkorrektur

-4.6 Installation und Anweisung

5 Projektergebnis

-5.1 Soll-Ist Vergleich

-5.2 Fazit

Ich denke so sieht es besser aus oder?

[Siggibyte]

ich habe zusätzlich noch:

> Änderungen zum Projektantrag

> Projektverlauf

> Ausblick

[niki]

@siggibyte

>Ausblick wollte ich im Fazit beschreiben

>Projektverlauf habe ich nicht angebunden, weil im Prinzip das im Soll-Ist Vergleich drin ist

Ansonsten:

5 Projektergebnis

-5.1 Abweichungen

-5.2 Soll-Ist Vergleich

-5.3 Fazit

[just_me]

Letztlich bist du der Einzige, der final beurteilen kann, ob diese Gliederung ausreichend ist.

IMO sieht sie okay aus. Zweifel hätte ich - da ohne Kenntnis des Kontextes - noch bei Punkt 4.2 sowie bei der Differenzierung zwischen Punkt 4.3 und 4.4, was auf den ersten Blick den Eindruck der "künstlichen Aufblähung" erweckt.

Nochmals: Vorsicht im Punkt 1. Deine Projektdokumentation hat als einziges Thema dein Projekt. Überflüssige Darlegungen, wie die Beschreibung deines Schreibtisches oder den Anfahrtsweg zur Tiefgarage deines Unternehmens haben dort nur dann etwas zu suchen, wenn du a) den Schreibtisch oder die Tiefgarage direkt in den Projekt involviert hast.

Werbung für dein Unternehmen (1.1) oder für einzelne Abteilungen (1.4, wenn CyberDemon recht hat) á là "Danken möchte ich Susi. Sie hat mir toll geholfen." hingegen mutet in einer Projektdokumentation eher ... ummm ... interessant an. Ich würde dir in jedem Fall, der nicht unmittelbar mit dem Projekt zu tun hat, sofort unterstellen, dass du Informationsmüll produzieren willst, um Seiten zu füllen.

Im Übrigen ist die ausschließliche Verwendung von Abbreviationen in Titeln (3.1.2) nicht gern gesehen.

Und schließlich: Was die "Abweichungen" (5.1) betrifft, können sie durchaus in deinem "Soll-Ist-Vergleich" (5.2) implizit sein (der ja sonst ziemlich langweilig wäre). Explizit werden sie eigentlich nur ausgewiesen, wenn die Änderungen gravierend waren. Dann jedoch bereits sehr weit oben --- also innerhalb von Punkt 1 (oder zumindest erfolgt dort ein strikter Verweis auf den Punkt "Abweichungen").

[Siggibyte]

Im Übrigen ist die ausschließliche Verwendung von Abbreviationen in Titeln (3.1.2) nicht gern gesehen

Was soll man anstatt von "ERM" bzw. "ER-Modell" schreiben?

[just_me]

Heißt es nicht "Entity-Relationship-Modell"?

Dann nenne es doch auch so.

Welchen Grund gibt es, Gutachter mit YAFA's zu malträtieren? Faulheit?

Im Übrigen gibt es für etliche TLA's multiple Bedeutungen:

ERM = Entity-Relationship-Modell

ERM = Enterprise Resource Management

Welches ist denn gemeint?

[timmi-bonn]

Original geschrieben von just_me

YAFA's [...] TLA's

saechsischer Genitiv??

gruß, timmi (irritiert)

[just_me]

*lol, eben das ist es, was ich meinte.

YAFA = Yet Another Fuc*** Abbreviation

TLA = Three Letter Acronym

[niki]

@just_me

Ich füge punkt 1.1 ein, weil mein betrieb nicht im IT-Branche tätig ist und dies will ich kurz beschreiben (von inhalt ist es nicht viel).

ERM(Entity-Relationship-Modell) wurde von mir nur hier im forum abgekürzt.

punkt 4.2 werde ich umbenennen in "Erstellen der Formulare" (klingt besser)

Bei der 4.3 u. 4.4 habe ich schon auch überlegt, ob ich das nicht zu einem Punkt "Programmieren" zusammenfassen kann. Aber dieser Schritt hat meiste zeit gekostet (ich hatte die module geschrieben und dann bei Forms eingebaut). Ich denke das wird zuviel für einen Punkt oder?

[Sandrin]

@just_me

Original geschrieben von just_me

Im Übrigen gibt es für etliche TLA's multiple Bedeutungen:

Original geschrieben von timmi-bonn

saechsischer Genitiv??

Original geschrieben von just_me

*lol, eben das ist es, was ich meinte.

YAFA = Yet Another Fuc*** Abbreviation

TLA = Three Letter Acronym

Hmm, als ehemaliger Einwohner der Vereinigten Staaten und somit zwangsläufig englisch sprechender Erdenbürger und ach so redegewandter Mensch, sollte dir eigentlich bewusst sein, worauf timmi-bonn angespielt hat.

Btw, wenn dann heißt es "TLAs" und von YAFA lässt sich absolut und rein gar nicht der Plural bilden, wenn man sich vor Augen hält, was die Abkürzung überhaupt bedeutet.

@niki

Ob du die Punkte 4.3 und 4.4 zusammenfasst oder so lässt, ist eigentlich Geschmackssache. Mach es so, wie es dir in der Doku am besten gefällt. Deine Tätigkeit, der Sinn und Zusammenhang bleibt - egal wie du es darstellst - ja gleich.

[just_me]

@Sandrin

Vielen Dank für deinen Hinweis.

Ich fürchte, du musst jetzt ganz stark sein: Auch ich bin nur ein Mensch.

Enschuldige in diesem Zusammenhang also bitte den Lapsus, der mir beim Versuch, aus Akronymen eine "lesbare Mehrzahl" (Gibt es eigentlich eine deutsche Norm, die klar definiert, wie der (umgangssprachliche) Plural [umgangssprachlicher [anglizistischer]] Akronyme zu bilden ist? Heißt es nun IHKs, IHK's, IHK'n oder ganz trivial IHKn? Und was liest sich flüssiger? Btw, werden manche Akronyme in ungarischer und andere in BL-Notation geschrieben? Wo finde ich einen "Duden der Akronyme"? Würde mich über diesbezügliche Hinweise freuen.) zu bilden, unterlief. Natürlich ist mir klar, dass es in diesem Sinne völlig unentschuldbar ist, dass ich, der ich auf andere Dinge achtete, nicht in der Lage war, umgehend den Sinn des Beabsichtigten korrekt zu deuten.

Ich werde mich bemühen, derartige Irritationen (also die eigenwillige apostrophierte Schreibweise meiner Akronyme), die offensichtlich völlig vom Inhalt abzulenken imstande sind, zukünftig weitestgehend auszuschließen.

@niki

Wie ich bereits sagte, letztlich kannst nur du es entscheiden.

"Zu viel für einen Punkt" kann allerdings kaum ein Argument sein, wenn es sich um lediglich 10-15 Seiten und über 20 Gliederungspunkte handelt. Eher wäre wohl das Gegenteil der Fall, nicht?

[timmi-bonn]

Original geschrieben von just_me

Gibt es eigentlich eine deutsche Norm, die klar definiert, wie der (...) Plural [...] Akronyme zu bilden ist? Heißt es nun IHKs, IHK's, IHK'n oder ganz trivial IHKn?

Nun, zumindest einesw ist sicher: Mit Apostrof ist ausnahmslos falsch. Egal, wie verbreitet diese Unsitte auch zu sein scheint.

Der Apostrof ist im Deutschen ausschließlich als Auslassungszeichen gestattet.

gruss, timmi

[Sandrin]

@just_me

Btw, werden manche Akronyme in ungarischer und andere in BL-Notation geschrieben?

Was hat die ungarische Notation mit Akronymen zu tun? Bei der ungarischen Notation wird nicht ein Wort aus Anfangsbuchstaben gebildet - wie es bei einem Akronym der Fall ist, sondern ein Variablenname oder eine Funktion aus Präfix und Bezeichner aufgebaut. Wo besteht jetzt der Zusammenhang?

[just_me]

Was hat die ungarische Notation mit Akronymen zu tun?

Als gebildeter, informierter und redegewandter Erdenbürger solltest du eigenlich so lustige Akronyme wie gTLDs (Ich lerne schnell. Das Apostroph habe ich schon weggelassen, siehst du!?) kennen, von denen mir scheint, dass sie die "klassische ungarische Notation" (kleingeschriebener Präfix + Bezeichner, welcher bei Akronymen ja in den unterschiedlichsten Schreibweisen existiert) aufweisen.

Und da du ja sehr bewandert in der Schreibweise von Akronymen bist oder doch wenigstens zu sein scheinst, und dich offensichtlich vornehmlich für Nebensätze und beiläufige Aussagen interessierst, dachte ich daran, unter Ausbeutung deiner Kenntnisse meine Wissenslücken zu reduzieren. Ist das jetzt ein falscher Zusammenhang?

edit: In diesem Zusammenhang habe ich gleich noch eine Frage: Nehmen wir an, ich hätte ein MLA, wie beispielsweise MOTSS. Da hier ja bekanntlich der Plural im ersten Wort zu bilden wäre, müsste ich dann also MsOTSS schreiben, ja? Und wie sieht es aus, wenn ich es Motss schreibe? Kann dann Msotss nicht zu Verwirrungen führen?

(Würde ich aber MOTSS's oder MOTSSs schreiben, wüsste eigentlich jeder, dass ich einen Plural meine, oder meinst du nicht?)

[timmi-bonn]

Original geschrieben von just_me

Würde ich aber MOTSS's [...] schreiben, wüsste eigentlich jeder, dass ich einen Plural meine, oder meinst du nicht?)

Falls Du mich mit zu der Menge "jeder" rechnest, dann muss ich Deine Frage mit einem eindeutigen NEIN beantworten (s.o.).

gruss, timmi

[Sandrin]

edit: In diesem Zusammenhang habe ich gleich noch eine Frage: Nehmen wir an, ich hätte ein MLA, wie beispielsweise MOTSS. Da hier ja bekanntlich der Plural im ersten Wort zu bilden wäre, müsste ich dann also MsOTSS schreiben, ja? Und wie sieht es aus, wenn ich es Motss schreibe? Kann dann Msotss nicht zu Verwirrungen führen?

(Würde ich aber MOTSS's oder MOTSSs schreiben, wüsste eigentlich jeder, dass ich einen Plural meine, oder meinst du nicht?)

Da dieses Akronym nicht wortwörtlich aus dem Englischen ins Deutsche übersetzt wird, erübrigt sich deine Frage.

Noch eine kleine Anmerkung: Akronyme widersprechen dem Grundgedanken der ungarischen Notation, da der Suffix in der ungarischen Notation möglichst keine, im Kontext unleserliche, Abkürzung sein sollte. Deswegen ist es absurd diese beiden Begriffe in einem Atemzug zu nennen.

Alles weitere, wenn überhaupt, per PN da ziemlich OT.

[just_me]

[erledigt]