Dokumentation erstellen, aber wie?

[goelliboy]

Hi,

ich bin seit Anfang August in der Ausbildung als FIAE.

In der letzten Woche habe mich mit in eine Software eingearbeitet, die für die Firma extra Programmiert wurde. Ich soll später die Programmierung von der Software übernehmen.

So meine Aufgabe ist es halt nun, dass ich eine Dokumentation für die Software erstellen soll, damit die Mitarbeiter (sind ein Reiseunternehmen) sich leicht in die Software einfinden können.

Mein Problem ist halt ganz einfach, wie erstelle ich am besten eine Dokumentation? Wie soll ich das erklären (Step by Step oder wie?).

Ich soll auf jedenfall mit Screenshots arbeiten. Wie sollte der Anfang einer Dokumentation aussehen?

Könnt ihr mit da mal weiterhelfen?

lg

Daniel

[IJK]

hm.

Hört sich mehr nach Anwenderhandbuch als nach Dokumentation aus.

Zu einem Anwenderhandbuch: Nimm dir einfach irgendein Excel-Handbuch und schau an, wie das gemacht ist.

Zum Thema Doku: Du benötigst da mehrere "Bücher", u.a.

- Installationshandbuch

- Betriebshandbuch

- Systemhandbuch

... und dann eben auch ein

- Anwenderhandbuch.

[MaleqAlhaq]

Falls es bei euch anwendbar ist: Versuch es mit einem WikiServer (oder sowas in der Art). Wenn ihr schon einen Server habt, kann man das relativ leicht integrieren. DArin kannst du dann zumindest eine Art "Index" erstellen bzw. etwas zum Nachschlagen erstellen. Ein Ersatz für ein gutes Handbuch ist das sicherlich nicht. Ich hab sowas selber in einer Arztpraxis als System für Qualitätsmanagement eingerichtet (Vorteil: An jedem Arbeitsplatz abrufbar -> man muss nicht immer den zentralen Ordner suchen.)

[..::rEnE::..]

Vorallem musst du es "Idiotensicher" machen, das heißt soviele Bilder und Beschreibungen/Erklärungen wie möglich - Sonst wird der User dich ständig mit Fragen nerven, weil er nicht daraus klg wird...

Hier z.B. ein Anleitung von mir die das Brennen mit der Windows-Eigenen Funktion beschreibt:

http://www.fisiserver.de/04fi02/ausbildung/ticona/Anleitung%20-%20Brennen%20unter%20Windows%20XP.pdf

(ist nur ne vorab-Version die ich mal auf den Server gelegt hatte, das kann Rechtschreibfehler etc. beinhalten!!!) - Nur zur Anschauung