Passa al contenuto principale

7. Riferimenti alla Documentazione nei Registri IANA

Di solito, i registri e le voci di registro includono riferimenti alla documentazione (RFC o altri documenti). Lo scopo di questi riferimenti è fornire agli implementatori puntatori per trovare i dettagli necessari per l'implementazione, NON semplicemente annotare quale documento ha creato il registro o la voce. Pertanto:

  • Se un documento registra un elemento che è definito e spiegato altrove, il riferimento registrato dovrebbe puntare al documento contenente la definizione, non al documento che sta semplicemente eseguendo la registrazione.

  • Se l'elemento registrato è definito e spiegato nel documento corrente, è importante includere informazioni sufficienti per consentire agli implementatori di comprendere l'elemento e creare un'implementazione appropriata.

  • Se l'elemento registrato è spiegato principalmente in una sezione specifica del documento di riferimento, è utile includere un riferimento alla sezione. Ad esempio, "[RFC4637], Section 3.2", anziché solo "[RFC4637]".

  • Per la documentazione di un nuovo registro, il riferimento dovrebbe fornire informazioni sul registro stesso, non solo un puntatore alla sua creazione. Le informazioni utili includono lo scopo del registro, una motivazione per la sua creazione, la documentazione del processo e della policy per le nuove registrazioni, linee guida per i nuovi registranti o designated experts, e altre informazioni correlate. Si noti tuttavia che, sebbene sia importante includere queste informazioni nel documento, non è necessario che siano tutte nella sezione IANA Considerations. Vedere Sezione 1.1.