web application user interface documentation

[Rene H.]

Hallo,

ich soll eine Dokumentation für unsere Web Applikation schreiben, jedoch habe ich so etwas noch nie gemacht. Es soll das user interface beschreiben.

Hat jemand von euch vielleicht einige Links/Beispiele zur Hand, wie so etwas ausshen kann?

Vielleicht habt ihr ja auch noch weitere Tipps, wie ich dies am besten und schnellsten lernen kann.

Vielen Dank für eure Hilfe
Rene

[dedlfix]

echo $begrüßung;

ich soll eine Dokumentation für unsere Web Applikation schreiben, jedocohne h habe ich so etwas noch nie gemacht. Es soll das user interface beschreiben.
Hat jemand von euch vielleicht einige Links/Beispiele zur Hand, wie so etwas ausshen kann?

Zur Genüge gibt es schlechte Vorlagen in Form von Dokumentationen anderer Projekte. Eine gute Dokumentation lässt für den Anwender keine Fragen offen. Dazu muss man sich aber in die Lage des Anwenders versetzen können. Meist ist einem ja das eigenen System bekannt und man versteht die Zusammenhänge, und die verwendeten Fachtermini was ein beginnender Anwender nicht unbedingt tut.

Ich lese gelegentlich Beschreibungen in dem Stil:

Feld Datum: Geben Sie bitte hier das Datum ein.

Ja klar. Es heißt ja nicht umsonst "Datum", also wird dort wohl ein Datum erwartet. Beschrieben ist aber nicht, in welchem Format das Datum erwartet wird, und vielleicht ist es aus dem Kontext auch nicht zweifelsfrei zu erkennen, um welches Datum es sich handelt oder warum hier ein Datum benötigt wird.

In dem Stil sind dann die Seiten der so genannten "Dokumentation" gefüllt, aber nützliche Information ist das nicht.

Mir ist nicht wirklich Literatur oder Dokumentation bekannt, wie man guten Dokumentationsstil lernen kann, aber vielleicht gibt dir dieser Beitrag aus Chris Shifletts Adventskalender einige Tipps, obwohl er auf Englisch verfasst ist und sich eigentlich auf die Dokumentation von Code bezieht: http://shiflett.org/blog/2007/dec/php-advent-calendar-day-2

echo "$verabschiedung $name";