7. Dokumentationsreferenzen in IANA-Registries

Üblicherweise enthalten Registries und Registry-Einträge Referenzen auf Dokumentation (RFCs oder andere Dokumente). Der Zweck dieser Referenzen besteht darin, Implementierern Hinweise zu geben, um Details zu finden, die für die Implementierung notwendig sind, NICHT lediglich zu vermerken, welches Dokument das Registry oder den Eintrag erstellt hat. Daher gilt:

• Wenn ein Dokument ein Element registriert, das an anderer Stelle definiert und erklärt wird, sollte die registrierte Referenz auf das Dokument verweisen, das die Definition enthält, nicht auf das Dokument, das lediglich die Registrierung durchführt.

• Wenn das registrierte Element im aktuellen Dokument definiert und erklärt wird, ist es wichtig, ausreichende Informationen bereitzustellen, um Implementierern zu ermöglichen, das Element zu verstehen und eine ordnungsgemäße Implementierung zu erstellen.

• Wenn das registrierte Element hauptsächlich in einem bestimmten Abschnitt des Referenzdokuments erklärt wird, ist es nützlich, eine Abschnittsreferenz anzugeben. Zum Beispiel "[RFC4637], Section 3.2" anstatt nur "[RFC4637]".

• Für die Dokumentation eines neuen Registries sollte die Referenz Informationen über das Registry selbst liefern, nicht nur einen Verweis auf dessen Erstellung. Nützliche Informationen umfassen den Zweck des Registries, eine Begründung für seine Erstellung, Dokumentation des Prozesses und der Richtlinie für neue Registrierungen, Leitlinien für neue Registranten oder Designated Experts sowie andere damit verbundene Informationen. Es ist jedoch zu beachten, dass diese Informationen zwar wichtig sind, aber nicht alle im IANA Considerations-Abschnitt enthalten sein müssen. Siehe Abschnitt 1.1.