ietf
[Top] [All Lists]

Re: Call for review of proposed update to ID-Checklist

2008-08-10 09:04:04
Hi,

things I'd like to see done in IDs more consistently:

In an Editorial Note on the front page:

- state on which mailing list discussions should take place (include mailing list archive and subscription links)

- point to issues lists when available


References:

- check that if the document obsoletes or updates another document, that one appear in the references section, and make sure that the document actually says what's going on with respect to the other documents (such as "Normative Changes from RFC xxxx")

- use symbolic references

- when quoting RFCs, consider calling out a specific section in the referenced document (it's preferable that the author does it once, instead of the readers having to figure it out; also, it helps revising the document when the referenced document was revised)


Code:

- when using xml2rfc, add type parameters to artwork so that things like ABNF can be automatically extracted and checked


Versioning:

- (this probably is controversial :-) - keep an appendix that gives a short overview of what changed compared to previous drafts


BR, Julian




_______________________________________________
Ietf mailing list
Ietf(_at_)ietf(_dot_)org
https://www.ietf.org/mailman/listinfo/ietf

<Prev in Thread] Current Thread [Next in Thread>