Passendes Konzept für eine Anwenderdokumentation

[Ralf Meyer]

Hi,

wir haben es folgendermaßen gelöst:
Wir haben eine Hilfe-Anwendung erstellt, die die Hilfetexte in der eigenen Datenbank speichert.
Intern werden ein ID-String bestehend aus Fenster, Komponentenname und Sprachkürzel als eindeutige Referenz herangezogen.

Die Hilfe selber besteht aus einem Kurztext und einem Langtext und einem Kommentarfeld.
Der Kurztext dient in der Ansicht als Orientierung.
Der Langtext wird als RTF in der abgespeichert und kann somit auch mit Bildern und Links versehen werden.

In der Anwendung wir über den zentral registrierten HotKey F1 die Hilfe zum Fenster aufgerufen. Strg+F1 ruf die Hilfe zu der aktiven Komponente auf.

Je nach Angemeldetem Benutzer kann dieser die Hilfe nur lesen, Kommentieren oder als Redakteur über den bereitgestellten RTF-Editor selber erweitern.
Es wird natürlich auch die Sprache übergeben, so das jedes Thema auch in der entsprechenden Sprache des Beutzers angezeigt bzw. bearbeitet werden kann.

Bei uns wird die Hilfe rege benutzt. Unsere Redakteure sehen aus den Kommentaren die der versierte User schreiben darf, was die User sich zusätzlich aufschreiben um den Programpunkt zu verstehen. Die gehen dann hin, und ziehen ihre Infos da raus um die Hilfe zu verbessern.

Somit haben wir ein lebendes System welches auch vom Anwender akzeptiert wird.

Gruß
Ralf