Skip to content

Conformance - Move to Clause 4 #405

@SteveLLamb

Description

@SteveLLamb

As per discussion with @ERyan71258 offline, conforming more to strict ISO directives (https://www.iso.org/sites/directives/current/part2), and their Norm Refs, we agree Conformance should be moved to Clause 4, based on the following:

  • Scope shall be numbered as Clause 1, as per ISO
  • Normative references shall be numbered as Clause 2, as per ISO
  • Terms and definitions shall be numbered as Clause 3, as per ISO
  • The tooling automatically puts in all three of the above clauses, with boilerplate even if no refs or terms are present
  • ISO does not allow for other non-numbered clauses at the start (only Foreword and Introduction - both informative)
  • The Conformance should NOT go back to the Foreword, as it's informative (and why it's currently at Clause 2, our best workaround at the time)
  • The next Clause after Terms is Technical content (which we call Prose clauses), which is one could argue what we provide in Conformance (with language like "A conformant implementation according to this document is one that includes all mandatory provisions..."), this isn't about JUST language, but about implementation conformance.
  • Nothing prevents or forbids defining requirements in a Prose clause, and this provides us with keeping it Normative. We are absolutely forbidden from requirements in Foreword.
  • Nothing prevents us from just declaring this is a SMPTE defined clause that must be present in our docs and shall always be Clause 4.

@tbause @raymondyyeungDBL @palemieux for discussion, and I plan on making this Topic 1 on the next HTML-Pub call on Tues, as we have 80% of the people on that call from ST.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions