Handbuch Frage
Verfasst: Mo Nov 09, 2009 12:20 pm
Und noch ne Frage
Macht es Sinn, wenn ich hier auch kleinere Ungereimtheiten in den Dokumentationen melde? Ich habe auch beruflich sehr viel mit Dokumentationen zu tun (lesend wie auch schreibend) und es gibt einfach ein paar Sachen, die mich beim Lesen einer Doku nerven (auch wenn ich solche Fehler sehr gerne in den eigenen Dokus einbaue ). Zum Beispiel im Z-Designer Handbuch, Kapitel "Der Zugscriptlauf". Hier ist die Rede von den E/K/F Flags. Da ich das Handbuch schon einmal durchgelesen habe, habe ich zumindest eine Vorstellung wozu diese Flags gut sind. Beim ersten Lesen tauchen hier aber ein paar Fragezeichen auf. Hier wäre vielleicht ein kleiner Hinweis darauf, wozu diese Flags dienen, nützlich. In der Regel wird man das eh überlesen (Motto: wird wohl später erklärt).
Ich will hier keinen Nerven und das Handbuchteam hat bestimmt genügend zu tun (sonst würde ja keine neuen Dokumentatoren gesucht), deswegen die Eingangsfrage.
Mein Gott, was bin ich heut' wieder pingelig
Servus
Heinz
Macht es Sinn, wenn ich hier auch kleinere Ungereimtheiten in den Dokumentationen melde? Ich habe auch beruflich sehr viel mit Dokumentationen zu tun (lesend wie auch schreibend) und es gibt einfach ein paar Sachen, die mich beim Lesen einer Doku nerven (auch wenn ich solche Fehler sehr gerne in den eigenen Dokus einbaue ). Zum Beispiel im Z-Designer Handbuch, Kapitel "Der Zugscriptlauf". Hier ist die Rede von den E/K/F Flags. Da ich das Handbuch schon einmal durchgelesen habe, habe ich zumindest eine Vorstellung wozu diese Flags gut sind. Beim ersten Lesen tauchen hier aber ein paar Fragezeichen auf. Hier wäre vielleicht ein kleiner Hinweis darauf, wozu diese Flags dienen, nützlich. In der Regel wird man das eh überlesen (Motto: wird wohl später erklärt).
Ich will hier keinen Nerven und das Handbuchteam hat bestimmt genügend zu tun (sonst würde ja keine neuen Dokumentatoren gesucht), deswegen die Eingangsfrage.
Mein Gott, was bin ich heut' wieder pingelig
Servus
Heinz