11 Mai 10 E-Mail-Link für Feedback in DITA-Dateien

Feedback des Nutzers

Durch einen E-Mail-Link auf jeder Seite der Dokumentation wird der Nutzer der Hilfe animiert, eher ein Feedback zur Dokumentation zu geben bzw. speziell Hilfe zur Seite anzufordern.

Abbildung 1. Feedback-Element zur Seite

Ein Klick auf den Link öffnet das E-Mailprogramm, in dem der Dateiname der Doku-Seite in der Betreffseite bereits vorgetragen ist.

Abbildung 2. Adresse und Betreff schon voreingetragen

Abbildung 3. Link funktioniert auch im PDF-Output

Attribute des xref-Elements

Die Attribute des xref-Elements sind besonders wichtig:
format=”txt”

und

müssen gesetzt sein.

Abbildung 4. Abstract-Element

Beschränkung auf Content-Seiten

Dieser Mail-Link sollte sich möglichst auf Content-Seiten beschränken. Auf Seiten, die nur der Navigation dienen, sorgt dies für Unübersichtlichkeit und ist somit überflüssig. Besonders prekär zeigt sich dies im PDF-Output.

Abbildung 5. Metaangaben der Navigationsdatei HTML-Format sind überflüssig

Spam

Sollte die Hilfe tatsächlich online – also im Internet veröffentlicht werden, ist die Veröffentlichung der E-Mailadresse natürlich eine Überlegung wert.