Wie erstellt man Dokumentationen?

    Hi!


    Ich muss jetzt für meine Kollegen Programm-Dokumentationen schreiben. Es geht dabei um die Handhabung von dem Programm.
    Man sollte vielleicht noch hinzufügen, das der Grossteil der Nutzer weiß, wie man den PC startet und wie man Word startet.


    Soll ich einfach drauf los schreiben? Es soll ja auch nicht zu "billig" klingen, à la "jetzt klicken Sie da hin und jetzt dort hin...".
    Oder gibt es bei Dokus Formulierungen, die man nutzen sollte?
    Hat vielleicht jemand ein paar Links zur Hand? Google hat mich nicht soo viel weiter gebracht.

    Danke, die Seite kannte ich noch nicht.


    Aber ich glaube, ich wurde falsch verstanden.
    Es geht mir nicht um ein selber programmiertes Programm. Ich hab nur für die Kollegen ein Programm installiert. Das sollen die jetzt nutzen. Nur haben die absolut keinen Schimmer, wie man mit dem Programm umgeht.

    Re: Wie erstellt man Dokumentationen?


    Hi,



    - wie wird die Anwendung gestartet? (Klingt einfacht ist es aber nicht immer)
    - wie benutzt man die wichtigen Arbeitsablaeufe?
    - wie beendet man das Programm nach beendeter Arbeit?
    - was fuer Sonderfunktionen gibt es, die man
    * oft braucht
    * selten braucht
    und wie benutzt man sie?


    Ueberall: nicht mit BIldern und Screenshots kleckern sondern klotzen!


    Prinzipiell solltest Du einen stichpunktartigen Beschreibungsstil verwenden, eine Struktur, die Du moeglichst durchhaeltst (also zB 1. Sinn und Ziel des Ablaufs 2. Beschreibung 3. Ergebnisse und moegliche Folgeablaeufe).
    Wenn Du einen ersten Draft hast, soll ein "durchschnittlich" begabter Benutzer das Ding lesen, versuchen zu benutzen und Dir Feedback geben.
    Denke daran: Das Ding soll keinen Literaturnobelpreis gewinnen, sondern dem Benutzer helfen. Also benutze fuer den gleichen Arbeitsschritt auch immer den gleichen Ausdruck (einmal "Anmelden" => immer "Anmelden") und suche nicht nach Synonymen. Halte Dich an eine Struktur, dass der Benutzer weiss, dass er zB den dritten Unterpunkt am Anfang immer ueberlesen kann, weil er erst im fortgeschrittenem Stadium interessant ist. (also lieber
    3. Einstellungsmoeglichkeiten
    keine
    als den Punkt weglassen oder gar ein nachfolgendes Thema zu 3. machen).


    cu
    XlF

    T39:
    Es geht um die Verschlüsselungs-Software PGP.


    XlF42:
    Danke, da sind ja richtig gute Tips dabei :top:
    Und ich soll wirklich mit wenig Screenshots arbeiten? Aber würde das für die Leute nicht sogar das Verständnis erhöhen?

    XlF42 meinte wohl eher, daß Du mit Screenshots nicht geizig sein solltest - lieber einen zuviel als zu wenig.


    Luposen

    Handys sind die einzigen Objekte, bei denen Männer sich streiten, wer das kleinere hat.

    Zitat

    Original geschrieben von T39
    Genug Anhaltspunkte für den Aufbau Deines Textes scheinen diese beiden Dokumentationen zu haben. Hoffe, dass Du die noch nicht kennst. ;)


    Dankeschön! :top:
    Den Umgang mit google muß ich wohl noch ein wenig üben :rolleyes:
    Den ersten Link kann ich zwar nicht öffnen, aber der zweite scheint so auf den ersten Blick recht gut geeignet zu sein. Da kann ich schon ein paar Formulierungen übernehmen.
    Ich werd mich da jetzt mal ans dokumentieren machen.



    Aber falls noch jemand weitere Tips haben sollte... immer her damit :)


    EDIT:
    Luposen:
    Du hast recht. Wer lesen kann ist klar im Vorteil. *schäm* :)

Jetzt mitmachen!

Sie haben noch kein Benutzerkonto auf unserer Seite? Registrieren Sie sich kostenlos und nehmen Sie an unserer Community teil!

Benutzerkonto erstellen Anmelden