Änderungen

Wechseln zu: Navigation, Suche

Hilfe:Leitfaden erstellen

1.092 Bytes entfernt, 10:30, 5. Dez. 2019
K
Aufbau eines Implementierungsleitfadens
=Workflow=
Die Einbindung eines neuen Leitfadens folgt einen einem vorgegebenen Prozess, dieser ist hier ersichtlich: unter[[Hilfe:Flagged_Revisions#Benutzung_von_Flagged_Revisions|Workflow]].
=Wiki-Hilfe=
Die Wiki Hilfe bietet eine Einführung, wie grundsätzlich mit einem Wiki gearbeitet wird und welche Markups zur Verfügung stehen: [[Hilfe:Wiki|How-to-Wiki]].
=Leitfaden im Wiki erstellen=
==Neue Seite anlegen==
Von einer bestehenden Seite aus kann mit folgender Syntax eine neue Seite angelegt werden: <pre>[[NeueSeite]]</pre><br/>
Sollen sich der Text des Links und der Seitenname unterscheiden , muss folgender Code benutzt werden: <pre>[[NeueSeite | Sichtbarer Text]]</pre> ===Neue Seite in einem Namespace anlegen/verschieben===Wenn die Seite bereits erstellt wurde, kann die Seite unter dem Reiter "Mehr" mit "Verschieben" in den gewünscht Namespace verschoben werden. Einfach statt (Artikel) den gewünschten Namespace auswählen und bestätigen.
==Verwendung von Namespaces==
Wenn die Seite noch nicht angelegt wurde, kann von einer bestehenden Seite aus mit folgender Syntax eine Seite in einem Namespace angelegt werden:
<pre>
[[ILF:NeueSeite]]
</pre>
Wenn die Seite bereits erstellt wurde, kann die Seite unter dem Reiter "Mehr" mit "Verschieben" in den gewünscht Namespace verschoben werden. Einfach (statt Artikel) den gewünschten Namespace auswählen und bestätigen.
==KonfigurationVersionierung von Wiki-Seiten==
Alle Seiten des Wiki unterliegen dem [[Hilfe:Flagged_Revisions|Flagged Revisions Verfahren]], das es ermöglicht, Seitenversionen zu markieren sowie eine stabile (Reiter "Lesen") und current Seitenversion (Reiter "Revision") festzulegen (https://www.mediawiki.org/wiki/Extension:FlaggedRevs). Die Seiten werden abschließend von so genannten Sichtern freigegeben.
===Aufbau eines Implementierungsleitfadens===Ein Implementierungsleitfaden teilt sich in einen technischen und einen textlichen Teil auf. Der '''technische Teil''' ist für den Leser nicht sichtbar und beinhaltet folgende Angaben:
* eine [[#Infobox |Infobox ]]
* die Hinweis, dass sich der Leitfaden [[#Under_ConstructionIn_Bearbeitung.2FUnderConstruction|in Bearbeitung]] befindet 
* [[#Formatierungen|Formatierung]] von Strukturbeispielen und dem Inhaltsverzeichnis
* die [[#Kapitelstruktur|trankludierten separat angelegten Abschnitte]] und [[#Namespace|Namespaces]]
* [[#SEO|Suchmaschinenoptimierung]]
Der '''textliche Teil ''' eines Wiki Leitfadens, beinhaltet den eigentlichen Inhalt(/Beschreibung) eines Implementierungsleitfaden. Implementierungsleitfäden sind sehr lange Dokumente und umfassen meist eine Seitenanzahl von über 200 mehrere Hundert A4 -Seiten. Deshalb ist kann es sinnvoll sein, das Hauptdokument in Teildokumente zu unterteilen. Die Summe der Teildokumente ergibt somit einen Leitfaden.
====Typische Gliederung eines Dokuments=Hauptdokument===Ein Das Hauptdokument bildet den eigentlichen Leitfaden wird typischerweise im Wiki ab und ist in folgende verschiedene Abschnitte gliederteingeteilt. Diese Abschnitte sind im Wiki sogenannten Teildokumente die in Summe den gesamten Leitfaden abbilden. Um die Teildokumente in das richtige Hauptdokument zu transkludieren, müssen dies ebenfalls dem Namensbereich "ILF" zugeordnet sein. Teildokumente werden im Hauptdokument folgendermaßen eingebunden:<br/>* Informationen über dieses Dokument** Allgemeines** Sprachliche Gleichbehandlung** Verbindlichkeit** Zielgruppe** Hinweis auf verwendete Grundlagen** <pre>{{ILF:Danksagung** Hinweise zur Nutzung des Leitfadens** Revisionsliste** Weitere unterstützende Materialien** Bedienungshinweise** Impressum* Harmonisierung* Einleitung** Ausgangssituation** Zweck** Hierarchie der Implementierungsleitfäden* Anwendungsfälle* Administrative Daten (CDA Header)* Fachlicher Inhalt (CDA Body)* Technische Konformitätsprüfung** Schema-Prüfung** Schematron-Prüfung** Online-Validation von CDA-Dokumenten* Anhang** Referenzen** Revisionsliste}}</pre>
====Hauptdokument=Teildokument===Das Hauptdokument bildet Die Teildokumente enthalten den eigentlichen Leitfaden im Wiki ab wiederverwendbare Textteile und ist in verschiedene Abschnitte eingeteilt. Diese Abschnitte sind im Wiki sogenannten Teildokumente die in Summe den gesamten Leitfaden abbilden. Um die Teildokumente in das richtige Hauptdokument zu transkludieren, müssen diese einen gewissen ebenfalls dem Namensbereich "ILF" zugeordnet sein. Teildokumente werden im Wiki folgendermaßen eingebunden: <br/><pre>elga-cdaalf-2.06.2:Harmonisierung</pre>
====Teildokument=Typische Gliederung eines Dokuments===Die Teildokumente enthalten den eigentlichen Text und müssen einem Namensbereich zugeordnet. Diese Namensbereiche werden im Vorhinein definiert und leiten sich aus den Titel des Leitfadens und In der Versionierung ab. Folgende Namensräume sind derzeit in Gebrauch:* Allgemeiner Leitfaden: Elga-cdaalf-2.06.2* XDS Metadaten: Elga-cdaxds-2.06.2* Entlassungsbrief (Ärztlich): Elga-cdaea-2.06.2* Entlassungsbrief (Pflege): Elga-cdaep-2.06.2* Pflegesituationsbericht: Elga-cdapsb-2.06.2* E-Medikation: Elga-cdaem-2.06.2* Laborbefund: Elga-cdalab-2.06.2* Laborbefund Version 2.06.03: Elga-cdalab-2.06.3* Befund Bildgebende Diagnostik: Elga-cdabgdGovernance zur Erstellung von Leitfadenerstellung wird die [[ART-2.06.2* Patient Summary: Elga-cdaps-2.06DECOR_Governance#Typische_Gliederung_eines_Dokuments|Typische Gliederung eines Dokuments]] vorgegeben.2
====Vollständiges Beispiel eines Implementierungsleitfadens====
Beispiel:
<pre>
</pre>
===in In Bearbeitung/UnderConstruction===
Um den Leser darauf hinzuweisen, dass dieser Leitfaden noch in Bearbeitung ist, muss die Vorlage „Underconstruction“ verwendet werden. Damit wird die Wiki-Seite visuell als „In Bearbeitung“ gekennzeichnet:
<pre>
==Eingebettete Unterseite wird nicht angezeigt==
Wenn eine Unterseite mit folgenden folgendem Code eingebettet wird
<pre>
{{Unterseite}}
</pre>
und nicht angezeigt wird, dann liegt es daran, dass die Unterseite nicht einem Namensraum zugeordnet ist.
Dazu lese Lesen Sie bitte dazu den Schritt: [[#Neue_Seite_in_einem_Namespace_anlegen.2Fverschieben|Seite einem Namensraum zuordnen]]
2.168
Bearbeitungen

Navigationsmenü