Ankündigung

Einklappen
Keine Ankündigung bisher.

Wie dokumentiert ihr eure Applikationen?

Einklappen
X
 
  • Filter
  • Zeit
  • Anzeigen
Alles löschen
neue Beiträge

  • Wie dokumentiert ihr eure Applikationen?

    Wie dokumentiert ihr eure Applikationen?
    Das ist natürlich kein einfaches Proble, es stellen sich die folgenden Fragen:

    -Wie umfangreich: Macht ihr eine einfache Hilfedatei oder ein mächtiger Hilfeassistent und ein Handbuch in Hochglanzpapier? (oder wo dazwischen?)

    -Auf welche Art: Ein Dokument in Wort/OpenOffice oder eine Hilfedatei mit Verknüpfungen mit einem Tool? (mit welchem Tool?)

    -Wann: Dokumentiert ihr bereits während dem Entwickeln oder wird erst eine Hilfe erstellt, wenn das Produkt schon fast fertig ist?

    Ich freue mich darauf, eure Meinungen dazu zu lesen.

    bis bald
    Kermit

    PS: Ergänzende Fragen, welche ich hier noch vergessen habe bitte ebenfalls stellen!

  • #2
    In den meisten Fällen garnicht, leider!

    Da ich mich noch nicht grossartig mit dem erstellen von Hilfedateien befasst habe kann ich keine Aussagen zu den betreffenden Formaten machen.

    grz zer00

    P.S. Ich schaue mir die Sache am Abend an, werde dann meine Erfahrungen posten

    Kommentar


    • #3
      Für den User:
      - Schnellstart-Anleitung
      - Benutzerhandbuch in dem alle Funktionen der GUI beschrieben sind
      - Tooltipps oder Direkthilfe bei kritischen Funktionen

      Falls es eine kleine Applikation ist, deckt womöglich die Schnellstart-Anleitung alles ab.

      Für den Admin:
      - Information über gespeicherte Daten (Wo?, Grösse?, Struktur?, Backup?)
      - Konfigurationshilfe für die App
      - Mögliche auftretende Fehler

      Entwickler (wenn du's sauber machen willst ist folgendes Pflicht):
      - Jede Funktion, Routine im Source Kommentieren, Funktion beschreiben, Parameter und Rückgabewerte dokumentieren
      - Einzelne Abschnitte in der Funktion, Routine zusammenfassend dokumentieren
      - Alles dokumentieren im Code was nicht auf Anhieb geklappt hat oder du länder nachdenken musstest.

      Die Dokumentation im Code machst du natürlich am Besten dann wenn du am programmieren bist.

      Die anderen Dokumente würde ich erstellen wenn ich sicher sein kann, dass sich an der Funktion oder dem Screen nichts mehr ändert.

      Teste deine Dokumentationen am Test-Benutzer! Nur er kann dir mitteilen ob er anhand der Doku mit der App arbeiten kann.

      Bei uns war das mal eine ganze Abteilung die 1 (!!!!) Jahr damit verbracht hat bei einer Billing-Software die Anwenderdoku durchzuspielen und zu überprüfen.

      Das kommt halt immer auf die Wichtigkeit der Applikation an, oder auch wie weit sich z.B. ein Helpdesk mit welchen Art von Fragen beschäftigen kann. Ich würde das vieleicht auch so machen, dass die wichtigen, täglichen Funktionen sehr ausführlich beschrieben sind.

      Bei weiteren Fragen einfach posten.

      Gruss Michi

      Kommentar

      Lädt...
      X