Wortwahl in der Dokumentation

[Ente19]

Ich bin Fachinformatiker Anwendungsentwicklung und gerade mit der Dokumentation beschäftigt. Nun stellen sich mir schon beim erstellen der Inhaltsangabe viele Fragen.

Beim Projektantrag hat es ja schon eine Rolle gespielt das ein paar Schlagwörter genannt wurden. Nun stelle ich mir die Frage ob Überschriften von Inhalten auch unbedingt vorhanden sein müssen.

Gibt es Überschriften die unbedingt sein müssen, und auch unbedingt so "lauten" sollten. Es gibt da ja immer die abstrakte Vorstellung von Prüfern die eine Liste mit Fachausdrücken neben sich haben und diese stupide abhacken

Kann dazu jemand vielleicht was genaueres sagen?

[darkasuka]

Würde mal sagen kommt auf dein Thema an, gibt son paar Pflichtsachen IST-Analyse, etc aber der Rest orientiert sihc an deinem Projekt

[Ente19]

Also ich Programmiere eine Serververwaltung für einen ISP. Es wird eine Anwendung im Browser mit PHP, die in eine MySQL die Daten schreibt.

Eine andere Kombonente in Perl geschrieben liest diese Daten wieder aus und überträgt sie auf das System.

Ich bin gerade dabei mein Inhaltsverzeichnis zusammenzustellen. Kann das ja nachher oder morgen mal Posten.

Oder hast Du vielleich schon ein muss

[diana]

Hallo,

wie schon geschrieben, gibt es solche allg. Stichpunkte, die man in jede halbwegs vollständige Dokumentation schreibt.

Die folgenden Stichpunkte müsstest du vielleicht in deiner Doku wieder finden:

-Zeitplanung für das gesamte Projekt

-Projektbeschreibung/ detaillierte Aufgabenstellung (oder IST/Soll)

-Realisierung (hier hast du die Freiheit deine Stichpunkte selbst einzuteilen, aber du solltest tiefer auf dein Projekt eingehen

Und dann denke ich das solche Dinge, wie Glossar, Literatur-, wie Abbildungsverzeichnis einfach dazu gehören!

Diese Anregungen solltest du noch etwas verfeinern und auch gern für deine Zwecke umformulieren. Ich kann auch nicht wirklich zu 100% sagen, ob es genauso gemacht werden soll, aber das ist von IHK zu IHK unterschiedlich und sehr relativ.

[Ente19]

Da Hast du schon recht, alles ist relativ

Aber danke Dir, im prinzip hat sowieso jede Dokumentatin eine Individuelle Note und wenn alle gleich wären, dann bräuchte man diese auch nicht bewerten Nur was ich eben meinte sind das die Planungsphasen, genau wie der IST, SOLL Beriech ja immer vorkommt. Egal welche Art von Projekt.

Du hast mir mit den Punkten schonmal weitergeholfen. Danke schön.

Wenn sonst noch jemand hier was schreiben will, ich wollte diesen Thread nun mit meinem Danke nicht als "erledigt" makieren

Nur zu....