Skip to content

Latest commit

 

History

History
49 lines (44 loc) · 1.69 KB

Document-Template-2020.md

File metadata and controls

49 lines (44 loc) · 1.69 KB

Current (as of late 2020) OASIS Document Template

In late 2020 OASIS updated their standard document template for a work product. The update notably re-arranged the contents of an OASIS specification / standard from the previous format. This description provides a quick overview of the new format; new work products should request a starter document from OASIS as described in Section 4.3.1 of the TC's Documentation Norms, to ensure that new products are alwasy begun using current OASIS guidance.

OASIS guidance for application of the new format is:

New stages of your existing specifications don't have to be modified to use the new templates, but you should be using the "2020style" for any new work, including new Version numbers of the existing specifications.

The outline of a specification in the new format is as follows:


  • 1 Introduction
    • 1.1 Changes from earlier versions
    • 1.2 Glossary
      • 1.2.1 Definitions of terms
      • 1.2.2 Acronyms and abbreviations
      • 1.2.3 Document conventions
    • 1.3 ... Other Introductory Material
  • 2 Section Heading
    • 2.1 Level 2 Heading
      • 2.1.1 Level 3 Heading
        • 2.1.1.1 Level 4 Heading
          • 2.1.1.1.1 Level 5 Heading
    • 2.2 Next Heading

Maximum of five heading levels
Additional sections can be inserted if needed.

  • 3 Conformance
  • Appendix A. References
    • A.1 Normative References
    • A.2 Informative References
  • Appendix B. Safety, Security and Privacy Considerations
  • Appendix C. Acknowledgments
    • C.1 Special Thanks
    • C.2 Participants
  • Appendix D. Revision History
  • Appendix E. Example Appendix with subsections
    • E.1 Subsection title
    • E.1.1 Sub-subsection
  • Appendix F. Notices