nicht angemeldet
Wie schreibt man ein Entwicklerhandbuch
Hallo,
kann mir jemmand sagen wie man ein Entwicklerhanbuch und/oder ein Benutzerhandbuch schriebt? Gibt es Vorlagen? Im Internet? Irgentwelche Tipps?
Danke im voraus, Marco
-
Hallo Marco,
also wie man ein entwicklerhandbuch schreibt, dass kann ich dir leider auch nicht sagen, das hab ich noch nie :o)
Aber ein benutzerhandbuch ;)
Versuch dich in den Benutzer reinzuversetzen. lass es am besten öfters von leuten lesen, die keine ahnung von deiner applikation haben.
Vermeide technische fachbegriffe, schreib es schritt für schritt immer im aufgabenkontext. lasse nichts weg, und wenn es dir noch so logisch erscheint. setze nicht vorraus, erklär dem benutzer lieber einmal mehr, wie man nen doppelklick macht, als einmal zu wenig. Guck viel Sendung mit der Maus, die machen dat gut ;o)
Gruß
Phil
--
ich bin ein nachmacher: http://www.eppstein.de -
Hallo Marco,
kann mir jemmand sagen wie man ein Entwicklerhanbuch und/oder ein Benutzerhandbuch schriebt?
Du musst schon etwas konkreter werden. Für welche Software, ist das Handbuch Begleitmaterial zur Software? Gibt es eine Onlinehilfe? Ist diese detaillierter als das Handbuch oder umgekehrt? Oder sollen Onlinehilfe und Handbuch (weitgehend) identisch sein? Handbuch zum selber ausdrucken (pfd) oder ausgedruckt zur Software. Was soll das Handbuch für den Entwickler festlegen? Soll es ein Styleguide für die Oberfläche sein, den Code? Wieviel kannst du beim Entwickler voraussetzen? Arbeiten diese alle zusammen oder sind ggf. externe Softwareentwickler beteiligt? (deutschsprachige?)
Gibt es Vorlagen?
vermutlich ja. Aber warum nimmst du dir nicht 3, 4 unterschiedliche Handbücher, sieh sie dir an und überlege was du daran gut findest, was weniger und machst dann aus diesen Informationen _deine eigene_ Vorlage.
Irgentwelche Tipps?
Langt dir das erst mal als Anregung?
Grüße,
Jochen
-
Also das Benuutzerhandbuch sollte auf eine einfache verstzändliche Weise kurz die Software (in Vb geschrieben) erklären.
Das Entwicklerhandbuch ist speziell für Entwickler gedacht, die die Software verbessern, erweiter,(reparieren) müssen, wenn ich nicht mehr da bin.
Ich dachte es gibt vielleicht ein paar Vorlagen, an dessen Stil ich mich ranhängen könnte.
-