Consistency Review

In this phase, the Working Group revises the Technical Documents before sending the document to the next step, Working Group Approval. This phase aims to evaluate the readability of the Technical Specifications by clarifying any content that is open for interpretation, removing any gaps, inconsistencies, or errors, and ensuring that the grammar, syntax, and written style is correct. The Working Group SHOULD consider opening the revision of the documents to third parties, customers, or other stakeholders that may be interested in the Technical Specifications but have yet to take part in their development. Validating Supporting Documents

Tasks

The image above depictures a sequential list of tasks. At the top of the image, you can see the color and the Working Group Role responsible for each task.

Prepare Gating Criteria

• The Editor of Technical document perform this task
• Documents in the repository enabler_template_repo contain guidelines and pieces of advice on how to write each document section.
• Here are the most critical sections and files to review:
  • index.yml or index.md file
    • Check that document properties are represented according to the guidelines and that all the documents are listed in the correct order under the files property
  • Appendices
    • Ensure that the Approved Version History section of the Appendix A contains placeholders for the final approval of the document
  • Markdown documents with Technical content
    • Check the content in the following sections:
      • Scope is an important section. It defines the content that is covered by the licensee's patent commitment.
      • Normative & Informative sections, ensure references to the documents meet the provided references.
      • Terminology & Conventions, ensure that the requirements follow the document conventions section. Each technical term in the document should contain a definition or abbreviation. Include terms defined externally, which may assist the reader in understanding them in the context of the document.
      • Introduction, it is a good practice to have an introduction section and insert a subsection for each new release version explaining what is new on that version.

Open Comment Period

After the Editor(s) complete the Gating Criteria task, the next step is to call for COMMENTS against the Technical Specifications.

• The Working Group Chair SHOULD send an email to the Group containing a link to the Technical Specifications under review, how long the review will last, e.g., two weeks, and where the COMMENTS SHOULD be sent.
• During this period, members and interested parties SHOULD read the Technical Documents and send COMMENTS if they identify any errors or omissions or believe the Group should clarify some statements.
• This review aims to identify any inconsistencies, errors, or gaps in the Technical Specifications before sending them for Working Group Approval.

Submit Comments, Objections

During the Review Period members and interested parties SHOULD raise any Issues and Pull Requests against the Technical Documents.

• The following information SHOULD be submitted when raising Issues:
  • Document and section of the document (take a screenshot of the section)
  • What is the problem?
  • What is the proposed solution?

Review Submissions

The Working Group MAY start reviewing Issues and Pull Requests raised at any time, even before closing the submission period.

• The Chair MAY organize or dedicate specific meetings to review the COMMENTS raised during the Review Period
• The resolution process for addressing Issues and Pull Requests submitted during the period is described in the Development Phase

Close Comment Period

The Close of Comment Period is set as a deadline to encourage the members to submit their COMMENTS in advance.

• The Working Group Chair SHOULD allocate as much time as needed to resolve all the COMMENTS (Issues and Pull Requests) submitted during the Review Period
• Ideally ALL the Issues and Pull Requests submitted during Review Period SHOULD be closed before proceeding to the next phase, Working Group Approval
• After Closing the Comment Period, it is not expected to receive anymore COMMENTS