Maxx: Wie schreibt man ein Entwicklerhandbuch

Beitrag lesen

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