Best Practice Erstellung eines Implementierungsleitfadens

Die Aufgabe des Implementierungsleitfadens ist es, alle Informationen, die für die Umsetzung einer Spezifikation relevant sind, in einem Dokument zusammenzufassen. Dabei geht der Inhalt des Dokumentes weit über die Zusammenstellung der technischen Artefakte hinaus.

Die Erstellung des Leitfadens sollte zu einem frühen Zeitpunkt im Projekt erfolgen und seine Inhalte in jeder Phase des Projektes fortgeschrieben werden.

Typische Inhalte eines Implementierungsleitfadens sind unter anderem:

  • Informationen zum Projekt (Ansprechpartner, Mitwirkungsmöglichkeiten, Dauer...)
  • Informationen zum Inhalt und Umfang des Projektes (Scope, Rahmenbedingungen, Roadmap, UseCases, Informationsmodell...)
  • Technische Spezifikation
  • Beispieldaten

Als Hilfestellung für Autoren hat das Technische Komittee für FHIR ein Template für einen vollständigen, mit nationalen und internationalen BestPractice-Empfehlungen abgestimmten Leitfaden erarbeitet.

Dessen Verwendung wird bei der Erstellung von Leitfäden dringend empfohlen.

zum Template

zum den Hinweisen zur Nutzung des Templates