Zum Hauptinhalt springen

8. Was in "bis"-Dokumenten zu tun ist

Gelegentlich wird ein RFC veröffentlicht, das eine frühere Ausgabe desselben Dokuments obsolet macht. Wir nennen diese manchmal "bis"-Dokumente, wie wenn RFC 4637 durch draft-ietf-foo-rfc4637bis obsolet gemacht werden soll. Wenn das ursprüngliche Dokument Register erstellt und/oder Einträge registriert hat, stellt sich die Frage, wie der Abschnitt IANA Considerations im "bis"-Dokument zu behandeln ist.

Wenn die Registrierungen das ursprüngliche Dokument als Referenz angeben, sollten diese Registrierungen aktualisiert werden, um auf die aktuelle (nicht veraltete) Dokumentation für diese Elemente zu verweisen. Normalerweise bedeutet dies, die Referenz in das "bis"-Dokument zu ändern.

Es wird jedoch Zeiten geben, in denen ein Dokument ein anderes aktualisiert, aber nicht obsolet macht, und die maßgebliche Referenz für einige Elemente geändert wird, für andere jedoch nicht. Stellen Sie sicher, dass die Referenzen immer auf die korrekte, aktuelle Dokumentation für jedes Element verweisen.

Nehmen wir zum Beispiel an, RFC 4637 hat das Flag "BANANA" im Register "Fruit Access Flags" registriert, und die Dokumentation für dieses Flag befindet sich in Abschnitt 3.2.

Das aktuelle Register könnte teilweise so aussehen:

Name        Description           Reference
-------- ------------------- ---------
BANANA Flag for bananas [RFC4637], Section 3.2

Wenn draft-ietf-foo-rfc4637bis RFC 4637 obsolet macht und aufgrund einer Umstrukturierung das Flag nun in Abschnitt 4.1.2 dokumentiert, könnte der Abschnitt IANA Considerations des bis-Dokuments folgenden Text enthalten:

IANA wird gebeten, die Registrierungsinformationen für das BANANA-Flag im Register "Fruit Access Flags" wie folgt zu ändern:

Name        Description           Reference
-------- ------------------- ---------
BANANA Flag for bananas [[this RFC]], Section 4.2.1

In vielen Fällen, wenn es eine Reihe registrierter Referenzen auf das ursprüngliche RFC gibt und die Dokumentorganisation die registrierten Abschnittsnummern nicht wesentlich geändert hat, kann es einfach vernünftig sein, dies zu tun:

Da dieses Dokument RFC 4637 obsolet macht, wird IANA gebeten, alle Registrierungsinformationen, die auf [RFC4637] verweisen, stattdessen auf [[this RFC]] zu verweisen.

Wenn Informationen für registrierte Elemente in andere Dokumente verschoben wurden oder werden, sollten die Registrierungsinformationen geändert werden, um auf diese anderen Dokumente zu verweisen. In den meisten Fällen sollten Dokumentationsreferenzen nicht auf das obsolete Dokument zeigen, wenn es sich um Register oder registrierte Elemente handelt, die noch in Gebrauch sind. Für Register oder registrierte Elemente, die nicht mehr in Gebrauch sind, ist es normalerweise sinnvoll, die Referenzen auf das alte Dokument zeigen zu lassen -- die letzte aktuelle Referenz für die obsoleten Elemente. Der Hauptpunkt ist sicherzustellen, dass die Referenzzeiger so nützlich und aktuell wie vernünftigerweise möglich sind, und Autoren sollten dies berücksichtigen, wenn sie die IANA Considerations für das neue Dokument schreiben. Wie immer: Tun Sie das Richtige, und es gibt Flexibilität, um dies zu ermöglichen.

Es ist äußerst wichtig, in Ihren Anweisungen bezüglich der Aktualisierung von Referenzen klar zu sein, insbesondere in Fällen, in denen einige Referenzen aktualisiert werden müssen und andere nicht.