Hilfe:Implementierungsleitfaden: Unterschied zwischen den Versionen
Zeile 13: | Zeile 13: | ||
Alle zugehörigen Dokumente sind in einem eigenen Wiki-Namespace unterzubringen. | Alle zugehörigen Dokumente sind in einem eigenen Wiki-Namespace unterzubringen. | ||
− | {{ | + | {{fmbox |
+ | | text = Dazu ist es nicht ausreichend, dass den Dokumenten ein Präfix mit abschließendem ":" vorangestellt wird, sondern die ausgezeichneten Wiki-Namespaces müssen gesondert vom Administrator eingetragen werden, damit sie als solche bekannt sind.}} | ||
Beispiel: <pre>cdaemp:</pre> ist der ausgezeichneten Wiki-Namespace für alle Dokumente zum Leitfaden "CDA elektronischer Mutterpass". Alle zu diesem Leitfaden gehörenden Dokumente sind mit diesem Namespcae-Präfix zu versehen. | Beispiel: <pre>cdaemp:</pre> ist der ausgezeichneten Wiki-Namespace für alle Dokumente zum Leitfaden "CDA elektronischer Mutterpass". Alle zu diesem Leitfaden gehörenden Dokumente sind mit diesem Namespcae-Präfix zu versehen. |
Version vom 9. Juli 2011, 14:59 Uhr
Inhaltsverzeichnis
Wie erstelle ich einen Implementierungsleitfaden
Einleitung
HL7 hat sich zum Ziel gesetzt, alle Implementierungsleitfäden und dazugehörige Dokumente, Terminologien, Templates und sonstiges im Wiki verfügbar zu machen. Um einen Leitfaden hier zu veröffentlichen, sind eine Reihe von Voraussetzungen zu erfüllen und die Leifäden bzw. die zugehörigen Teildokumente müssen nach bestimmten Kriterien erstellt werden, um als Leitfäden oder Teilen davon erkannt zu werden und um die Extraktionsmöglichkeit als PDF-Dokument zu ermöglichen.
Grundsätzliches und Gute Praxis der Wiki-Leitfäden
Leitfäden sind meist lange Dokumente. Es ist deshalb sinnvoll, diese in Teildokumente zu unterteilen, die dann zu einem einzigen Leitfaden zusammengefügt werden.
Voraussetzungen
Namespace
Jeder Leitfaden ist ein eigenständiges Dokument, dass im Wiki-Namespace "IG:" anzulegen und zu pflegen ist.
Beispiel: Das Hauptdokument des Leitfadens "elektronischer Mutterpass" ist angelegt als
IG:HL7_CDA_Mutterpass
Alle zugehörigen Dokumente sind in einem eigenen Wiki-Namespace unterzubringen.
Dazu ist es nicht ausreichend, dass den Dokumenten ein Präfix mit abschließendem ":" vorangestellt wird, sondern die ausgezeichneten Wiki-Namespaces müssen gesondert vom Administrator eingetragen werden, damit sie als solche bekannt sind. |
Beispiel:
cdaemp:
ist der ausgezeichneten Wiki-Namespace für alle Dokumente zum Leitfaden "CDA elektronischer Mutterpass". Alle zu diesem Leitfaden gehörenden Dokumente sind mit diesem Namespcae-Präfix zu versehen.