Metadaten-Chaos: Komplette Topics filtern

Der Dating DITA-Vortrag kommt mir gerade wieder in den Sinn, wo ich mich Metadaten beschäftige. Und da stehen mir wirklich die Haare zu Berge – das ist das erste Mal, dass ich DITA wirklich, wirklich unpraktisch finde und noch keine gute Lösung habe, wie ich da in Zukunft verfahren soll.
Wie man komplette Topics nicht rausfiltert
Nehmen wir mal an, ich generiere aus einer Map einen User-Guide und einen Admin-Guide. Viele Inhalte überschneiden sich, aber einige sind exklusiv nur für eine der Zielgruppen gedacht.

Bisher dachte ich mir das so: Wenn ich von einem kompletten Topic weiß, dass es nur audience=“user“ ist, dann setz ich das Attribut auf das Root-Element, also so:
<task id="123" product="wundertuete2" audience="user">...

Dann wird doch dieses Topic, auf diese Weise attributiert, nun beim Generieren des Admin-Guides bestimmt nirgends verlinkt bzw. gar nicht erst generiert.

Weit gefehlt. Das Topic wird generiert und zwar leer (und damit nicht valide). Alle Verlinkungen, sprich: alle Topicrefs, sind auch im Output existent, führen aber natürlich ins Leere.

Wie man komplette Topics wirklich rausfiltert
Um zu verhindern, dass etwas überall verlinkt wird, muss man das Attribut auf jeden Topicref setzen!
<topicref id="123" product="wundertuete2" >
<</topicmeta></topicref>

Und zwar auf wirklich jeden, auch die in den Relationship tables. Und das in allen Maps in denen das Topics vorkommt. Wenn ich da an zentrale, so gut wie immer gültige Attribute wie audience oder product denke, wird mir übel. Wie soll man das denn anständig pflegen oder gar mal aktualisieren? So müsste jeder Redakteur für jedes Topic erneut prüfen, welche Gültigkeit es hat und es auch wieder in der Map hinterlegen. Und darauf hab ich eigentlich überhaupt keine Lust.

(Im Übrigen gilt das Prinzip nicht nur für Topicrefs, sondern auch für den Einsatz anderer interner Verlinkungsarten wie xref oder related-links)

Zudem ist es sehr inkonsistent, dass es hier plötzlich ein eigenes Element audience gibt, zusätzlich zum gleichnamigen Attribut. Um die Verwirrung zu komplettieren, kann man beides gleichzeitig auf einen einzelnen Topicref beziehen.

<topicref id="123" product="wundertuete2" audience="user">
<topicmeta></topicmeta></topicref>

Eine passende Diskussion auf der Yahoo-Group hab ich schon gefunden, aber eben leider noch keine Lösung. Und sowas muss ich kurz vor dem Wochenende rausfinden 🙁

Standardisieren ohne Kopf

Wenn man sehr viel schreibt, passiert es gut und gerne, dass man sich bestimmte Schreibmuster angewöhnt ohne darüber nachzudenken.

Sehr beliebt sind bei mir Füllwörter jeder Art, die ich bei meiner Master-Thesis am Ende per Strg+F suchen konnte, weil es zur der Zeit immer die dieselben zwei waren 😉 Ansonsten sind Schreibmuster für einen technischen Redakteur nicht das Schlechteste, da man schließlich standardisiert arbeiten soll. Aber in manchen Fällen denkt man vor lauter Standardisierung nicht mehr richtig nach.

Ich hab gestern bspw. ein kleines Review der Doku gemacht, an der ich gerade arbeite. Ich habe nach dem Muster „Klicken Sie auf XY, um das den Leuten ein X für ein U vorzumachen“ gearbeitet. Und zwar sehr streng. Zu streng. Zu kopflos.

Sätze wie „Klicken Sie auf Speichern, um zu speichern.“  erzeugen nur Textmüll und bringen keinen Mehrwert im Gegensatz zu „Klicken Sie auf Speichern.“. Vermeide das Offensichtliche, sag ich da nur!