Hinweis FAQ

Allgemeine Grundsätze

  • KISS: Keep It Short and Stupid (Fachfremde und ungebildete müssen es verstehen)
  • Positiv formulieren / keine doppelte Verneinung: "Wo darf ich nicht?", besser: "Wo darf ich?"
  • Fragen und Antworten atomar halten: eine Frage und Antwort hat nur ein Thema - untergeordnete Themen auslagern.
  • Redundanz vermeiden: Antworttext darf in nur genau einer Frage enthalten sein.
  • Begriffsdefinitionen: offizielle Begriffe verwenden, also "Maßstab" statt "Zollstock"
  • Fachbegriffe (richtig) verwenden
  • Antwort ohne Umschweife formulieren. D.h. die Antwort muss im ersten Satz stehen. Was danach kommt sind Erläuterungen, Sonderfälle, ...
  • Kein Halbwissen oder Unwahrheiten

Antworten

Fragen die mit Ja oder Nein beantwortet werden können, sollten auch damit beantwortet werden. Die Antworten ohne Umschweife formulieren. Klare Formulierungen mit einfachen Worten und einfachen Sätzen. Die eigentliche Antwort muss im ersten Satz formuliert sein, gegebenenfalls mit Hinweisen auf Ausnahmen.

Die Antworten müssen auch ohne Vorwissen verstanden werden können. Auf der anderen Seiten darf nicht in jeder Antwort das Universum erklärt werden.

Hinweise auf Gesetze, Normen usw. sind sehr gut, dürfen aber nur als "weiterführende Informationen" gesehen werden. Solche Texte sind für ungeübte meist schwer zu verstehen und sollten daher nicht oder nur mit Erläuterung zitiert werden.

Beispiel

Frage: Wo darf mein Gepäck nicht hinstellen?

Die Antwort beginnt so: In allen Bereichen die laut Brandschutzverordnung DIN 14XXX und ISO-XXXX14 erhöhte Gefahrenpotentiale beherbergen oder mit der StVO in Konflikt stehen. ...

Besser wäre
Frage: Wo darf ich mein Gepäck abstellen?

Die Antwort beginnt so: Sie dürfen Ihr Gepäck grundsätzlich überall hinstellen. Allerdings gibt es Ausnahmen: Verkehrswege müssen freigehalten werden (siehe StVO). Verkehrswege sind markiert. Außerdem müssen aus Gründen des Brandschutzes (Siehe DIN 14XXX und ISO-XXXX14) weitere Bereiche frei gehalten werden. Diese Bereiche sind ebenfalls markiert. ...

SEO und URLs

Die Listen der FAQ-Einträge sowie die einzelnen Fragen und Antworten werden automatisch so ausgegeben, dass sie von Suchmaschinen gelesen werden können. Dazu gehört Structured-Content ebenso wie lesbare URLs.

Um die Maschinenlesbarkeit der FAQ zu gewährleisten, wird "structured data" sowohl in der Listendarstellung, sowie in der Detailansicht mit ausgegeben. Siehe schema.org. Diese Informationen werden hauptsächlich von Suchmaschinen ausgewertet um Inhalte zu Kategorisieren und Suchergebnislisten besser darzustellen.

Jeder FAQ-Eintrag erhält dabei eine eindeutige URL, die sich aus der BasisURL, der Id und der Frage zusammensetzt. Beispiel: [[PROTOCOL]]://[[SERVER]][[SELF]]faq/1000/Wie+spät+ist+es. Für die Funktionalität ist die BasisURL und die Id ausreichend ([[PROTOCOL]]://[[SERVER]][[SELF]]faq/1000). Das sorgt für kurze URLs, die sich leicht buchstabieren oder per E-Mail versenden lassen.