Proposal for specification layout
Title - required
Single Line Capitalized Title
Examples:
JSON Responses for the Registration Data Access Protocol (RDAP)
Verifiable Credentials Data Model v2.0
Additional Info
Status: ToIP Task Force Draft
This version
Latest published version
Latest editor's draft
Editors
Authors
Feedback
Scope - required
Short introductory paragraph
Examples:
Foreword - required
New text to be defined by this TF
Examples:
Conventions - required
Terms and Definitions - recommended
The following terms are used to describe concepts in this specification.
decentralized identifier (DID)
definition
key event log (KEL)
definition
Terms are listed in lower case, alphabetical order and used inside the specification in lower case, unless being referred to by a defined acronym.
Linking back to the definition of a term using the spec-up [[ref: ]] macro is left to the authors discretion.
A suggested use would in a new section, or where the term has been previous defined and context may have been lost to the reader.
Content Title
Wonderful specification content.
...
Considerations - recommended
May include but not limited to IANA/Security Considerations listed by title in alphabetical order
References - recommended
Format
Reference should use the Markdown . (period) : (colon) syntax.
[1]. Smith, Samuel M., Meta-Platforms and Cooperative Network-of-Networks Effects: Why Decentralized Platforms Will Eat Centralized Platforms. 2019/03/25 https://medium.com/selfrule/meta-platforms-and-cooperative-network-of-networks-effects-6e61eb15c586
[1]: https://medium.com/selfrule/meta-platforms-and-cooperative-network-of-networks-effects-6e61eb15c586These can then be used inline by using [1].
Revision History - recommended
format TBD
Annex - optional
a supplementary document or section that is added to the main document to provide additional information that is not included in the main body. An annex can be a separate document or a part of the main document, but it is always attached at the end of the document.
Appendix - optional
a section that is added to the end of a document to provide additional information that is related to the main body of the document. An appendix can contain any type of information that supports the main content, such as charts, graphs, tables, images, or detailed descriptions.