Inhalts- und Textgestaltung

18.6.4. Inhalts- und Textgestaltung#

Dieses Kapitel enthält die verbindlichen fachlichen, sprachlichen und redaktionellen Konventionen des Kompendiums. Die allgemeine MyST-Einführung steht in MyST-Markdown Kurzanleitung, projektspezifische Quelltext- und Dokumentenstrukturregeln in Style Guide – MyST-Markdown (Medizinisches Kompendium) und visuelle Gestaltungsvorgaben in Design Guidelines.

Sprache und medizinisch-wissenschaftliche Redaktion#

  • Publikationstexte sind grundsätzlich deutschsprachig und verwenden die in Österreich übliche medizinische Fachterminologie

  • Fachliche Aussagen müssen präzise, überprüfbar und ihrem Evidenzgrad angemessen formuliert sein

  • Bestehende, literaturgestützte klinische Positionen einschließlich ihrer Einschränkungen bleiben inhaltlich erhalten, solange keine begründete fachliche Änderung beschlossen wurde

  • Für Arzneimittel ist die einschlägige Fachinformation (Summary of Product Characteristics, SmPC) vorrangige Referenz

  • Abweichende klinische Praxis, Off-Label-Anwendungen und ungeklärte Widersprüche zur Fachinformation sind ausdrücklich als redaktioneller Markdown-Kommentar (<!-- ... -->) oder MyST-:::{todo} zu kennzeichnen und mit Quellen zu hinterlegen

  • Fachinformationen, Leitlinien und Primärstudien sind hinsichtlich ihrer Verbindlichkeit beziehungsweise Aussagekraft zu unterscheiden

  • Klinisch relevante Angaben, insbesondere zu Indikationen, Kontraindikationen, Dosierungen, Konzentrationen, Höchstdosen, Applikationswegen, Pharmakokinetik, Schwangerschaft und Stillperiode, bedürfen nachvollziehbarer und hinreichend aktueller Belege

  • Unbelegte Behauptungen, erfundene PMIDs oder DOIs, fiktive Studienergebnisse, Spezialitäten oder Literaturquellen sind unzulässig

  • Fehlende oder nicht verifizierte Angaben werden im betreffenden Feld mit keine Angabe bezeichnet und mit einem konkreten, unsichtbaren TODO versehen, beispielsweise <!-- TODO: Midazolam: Stillperiode anhand der Fachinformation prüfen. -->

  • Nichtssagende Ersatzformulierungen statt einer fehlenden Angabe sind zu vermeiden

  • Fachlich bedeutsame Einschränkungen wie ultima ratio, Rescue-Therapie oder Aussagen zu unsicherer Evidenz bleiben ausdrücklich sichtbar

Hervorhebungen und Textgestaltung#

  • Einfache Hervorhebungen kennzeichnen insbesondere Fachbegriffe, Parameter und Konzepte, soweit dies zum Verständnis beiträgt.

  • Starke Hervorhebungen kennzeichnen wichtige klinische Kernaussagen, nicht bloß wiederholte Überschriftenbegriffe.

  • Schlüsselworte können mittels {emph}-Rolle (einfache Hervorhebungeinfache Hervorhebung) und {strong}-Rolle (starke Hervorhebungstarke Hervorhebung) gesetzt werden. Diese Rollen erzeugen einen zusätzlichen Eintrag in der Randspalte.

  • Begriffe der unmittelbar zugehörigen Überschrift werden im Fließtext nicht allein deshalb erneut hervorgehoben.

  • Bei hervorgehobenen Bezeichnungen endet die Auszeichnung vor dem folgenden Satzzeichen, beispielsweise **Wirkungseintritt**:.

  • Die semantische Auszeichnung bleibt auch dann im Quelltext erhalten, wenn die PDF-Schrift Lexend keine eigene Kursivform verwendet.

  • Jeder Abschnitt soll klinisch verwertbare Information vermitteln und präzise sowie knapp formuliert sein.

Typografie, Einheiten und Fachbezeichnungen#

  • Dezimalzahlen in deutschsprachigen Publikationstexten verwenden das Dezimalkomma

  • Für Tausendergruppen und zwischen Zahlen und Einheiten wird nach Projektkonvention das schmale geschützte Leerzeichen U+202F verwendet, beispielsweise 1 000, 120 mm Hg und 2 mg / kg

  • Zahlenwerte, Konzentrationen, Dosierungen, Applikationswege, Infusionsdauern und Einheiten werden exakt wiedergegeben; medizinisch relevante Rundungen sind ausdrücklich zu begründen

  • Arzneimitteldosierungen werden bevorzugt in mg statt in µg/mcg ausgedrückt

  • Bei Bruchteilen von Milligramm sind mindestens drei Nachkommastellen zu verwenden, beispielsweise 0,025 mg oder 0,050 mg

  • Bei Spezialitäten und Markennamen wird ™ statt ® verwendet, auch in Indexeinträgen; wortgetreue Quellenzitate bleiben davon ausgenommen

  • Etablierte medizinische Termini sowie benannte Geräte, Verfahren und Fachbegriffe bleiben terminologisch eindeutig

  • Abkürzungen wie z. B. und d. h. verwenden das schmale geschützte Leerzeichen (U+202F) zwischen ihren Bestandteilen

  • Zahlenbereiche werden mit dem Halbgeviertstrich (–) dargestellt, beispielsweise 50–70 kg

  • Doppelte Leerzeichen werden außerhalb der beabsichtigten MyST-Einrückung vermieden

Pharmakopeia: Aufbau der Arzneimittelmonographien#

Arzneimittelmonographien folgen grundsätzlich dieser Reihenfolge:

  1. Wirkstoffname beziehungsweise Titel

  2. Field-List-Eintrag Spezialitäten/Markennamen

  3. Kurze Beschreibung des Wirkstoffs

  4. Field-List-Eintrag Wirkung

  5. Field-List-Eintrag Indikationen

  6. Field-List-Eintrag Kontraindikationen

  7. Field-List-Eintrag Dosierungen

  8. Field-List-Eintrag Nebenwirkungen

  9. Field-List-Eintrag Pharmakodynamik

  10. Field-List-Eintrag Pharmakokinetik einschließlich Metabolismus/Abbau und Elimination

  11. Field-List-Eintrag Schwangerschaft und Stillperiode

  12. Field-List-Eintrag Sonstiges

  • Die Abschnitte werden als MyST-Field-List-Einträge geführt, nicht als zusätzliche Markdown-Überschriften

  • Unter Dosierungen werden Unterpunkte nach Indikation und bei Bedarf zu Nierenfunktion, Leberfunktion, Kindern und geriatrischen Patienten verwendet; keine verschachtelten Field-Lists

  • Konzentrationen, Bolus- und Infusionsschemata, Wiederholungsintervalle, Höchstdosen, Organfunktionseinschränkungen und Indikationsbezug sind vollständig und eindeutig anzugeben

  • Bei hervorgehobenen Bezeichnungen endet die Formatierung vor dem Satzzeichen, beispielsweise **Wirkungseintritt**: und nicht **Wirkungseintritt:**

  • Im Fachtext genannte CYP-Isoenzyme erhalten direkt an der jeweiligen Nennung einen hierarchischen Indexeintrag, beispielsweise {index}`CYP2D6; Ajmalin`

  • Hierarchische Indexeinträge verwenden ein Semikolon (Oberbegriff; Unterbegriff) statt einer Klammerkonstruktion

  • Bereits vorhandene Glossar-, Index- und Literaturreferenzen werden nicht versehentlich dupliziert

Literaturverzeichnis und Literaturreferenzen#

  • Folgende Literaturkennzeichen werden verwendet:

    • 🗎 für Primärliteratur

    • 🕮 für Sekundärliteratur, Bücher, Bedienungsanleitungen etc.

    • ♛ für Leitlinien

    • ⚖ für Rechts- und Behördenquellen, ausgenommen Gesetze und Verordnungen. Österreichische Gesetze und Verordnungen werden direkt auf das Rechtsinformationssystem des Bundes (RIS) verlinkt.

    Referenzschlüssel folgen dem Muster 🗎 Autor Jahr, beispielsweise 🗎 Kotani 2023, für Bücher o.ä. 🕮 Autor Kurztitel Auflage (z. B. 🕮 Lippert Anatomie 4).

  • Ein Literaturverzeichniseintrag umfasst fett ausgezeichneten Publikationstitel, Autorinnen und Autoren, Zeitschrift und Publikationsdatum sowie – falls vorhanden und verifiziert – PMID und DOI

  • Eine kurze, inhaltlich aussagekräftige Kernaussage in einem Blockzitat schließt den Eintrag ab

  • Literaturangaben müssen bibliografisch korrekt sein; vorhandene Einträge dienen als konkrete Muster für Interpunktion und Reihenfolge

  • Verweise auf Literatur in Fachkapiteln verwenden die vorhandene MyST-Syntax, beispielsweise ({term}`🗎 De Backer 2010`); mehrere Literaturreferenzen können innerhalb einer Klammer kombiniert werden

  • Bestehende Literaturverweise bleiben in ihrer konkreten Schreibweise erhalten, sofern kein nachgewiesener bibliografischer oder fachlicher Änderungsbedarf vorliegt

  • Im CHANGELOG werden keine MyST-{term}-Literaturverweise verwendet, weil der Changelog-Text auch außerhalb des MyST-Projekts genutzt wird

  • Literaturverweise im CHANGELOG erscheinen als Klartext, beispielsweise (🗎 De Backer 2010) oder (🗎 Bellomo 2000, 🗎 Friedrich 2005, 🗎 Chen 2013)

CHANGELOG: Aufbau und redaktionelle Regeln#

  • Das CHANGELOG befindet sich unter Text/CHANGELOG.md.

  • Hauptversionen verwenden Überschriften der Ebene 2 (##), Vorabversionen Ebene 3 (###)

  • Jede Version erhält einen passenden MyST-Indexeintrag und ein explizites Label unmittelbar beim Überschriftenblock

  • Die Regel zu fünf Leerzeilen vor Überschriften gilt auch im CHANGELOG

  • Ab der fünften Gliederungsebene werden Field-Lists mit ungeordneten Listen statt tieferer Überschriften verwendet

  • Änderungen werden thematisch und nicht lediglich in Git-Commit-Reihenfolge dargestellt

  • Übliche thematische Gruppen sind Dokumentation/Technik, Herz-Kreislauf und Reanimation, Atemwege und Beatmung, Maßnahmen und Anatomie; sie werden nur eingesetzt, soweit der Inhalt sie rechtfertigt

  • Bei jedem einzelnen Aufzählungspunkt werden sämtliche dafür relevanten Commits als verlinkte siebenstellige Kurz-IDs genannt

  • Dieselbe Commit-ID darf und soll bei mehreren passenden Aufzählungspunkten erneut erscheinen

  • Zu jeder Version gehören die korrekte Tag-Bezeichnung, der tatsächlich zugehörige vollständige Commit-Hash und das Datum

  • Kommentierte Commit-Platzhalter bleiben nur dort bestehen, wo sie Bestandteil einer ausdrücklich genehmigten Fassung sind

  • Historisch freigegebene Changelog-Einträge werden wortgetreu bewahrt; insbesondere ist der manuell verabschiedete Eintrag v4.0.0-alpha.414 maßgeblich

  • Bereits vom Herausgeber festgelegte, vollständige Versionsbeschreibungen haben gegenüber einer unvollständigen Rekonstruktion aus Commit-Nachrichten Vorrang

  • ET26090A und ET35071A sind Maßnahmencodes und gehören zu Maßnahmen

  • MP1 gehört zu Medizinprodukte, MED-THE zu Medizinisch-Wissenschaftlicher BASISteil und OE/UE zu Anatomie