-
Notifications
You must be signed in to change notification settings - Fork 0
Home
We are working on revising the OCP Specification guidelines and template(s).
This is the start of the journey to align on a baseline expectation of quality & detail.
We desire to:
- Create order within the system
- Fully articulate the fundamentals
- Upheld by the community and the submission process
- Focus on Openness & enabling the market
- Templates & process
- Flexibility for usages
- Minimize the effort required by community, keep to the basics
- Templates & process
- Emphasize connectivity & data discovery
- Associativity between workflows and projects
- Ex. design spec releases before base
- Dependencies & adjacencies within the community
- Educate as well as inform
- Associativity between workflows and projects
We'll use the wiki as a billboard to advertize the proposed changes to the OCP specification process, guidelines, and templates. We need feedback as we wish to learn and course correct early. An email will be sent on the group.io to alert subscribers to major changes
We are using markdown to document (not rendering but relying on github preview) and issues for feedback. Issues should initially be assigned to russw-OCP. If filing an issue is a hurdle too high, send an email to [email protected] and the issue will be filed.
Once we formalize the documentation, then we'll figure out the publishing aspects. We are investigating various markdown and LaTex flows which will likely be a separate thread ...
2025/12/10
-
Suspension of the Errata process while we re-evaluate the need.
The current errata process is intended to allow simple corrections without reissuing the original specification. However, in practice, the three instances where the errata process was used resulted in full specification releases rather than incremental updates.
Implementing errata effectively requires clear mechanisms to append change notices to specifications and a defined process to ensure that the “official specification” includes both the original document and any errata. These mechanisms are not in place today.
We are seeking community feedback (please file an issue) on the value of the errata process and the proposal to permanently remove from the specification workflow. -
Updates to the "OCP Terminology Guidelines for Inclusion and Openness".
The current version is here.
Please review the WIP version and provide feedback by filing an issue. -
Framework started in the "proposed guidelines for specifications"
The current Base Template which has embedded guidelines.
The current naming convention
Please review the WIP version and provide feedback by filing an issue. -
Simplified base specification and de-embedded instructions. Have a look and provide feedback
Simplified over current version (link above). You'll want to read the instructions prior to template. base specification instructions base spec template