OpenPOWER Library

 1.6. Publishing OpenPOWER Documents

The OpenPOWER Foundation Work Group (WG) Process document found in the OpenPOWER Foundation Members Community documents is the definitive guide for understanding OpenPOWER Foundation documents and their work flow. Details such as the duration and types of reviews as well as approval voting specifics are found in this document.

This section of the guide does not attempt to provide process details, but instead strives to provide an overview to help writers understand enough of the basics to know how to prepare their document and what to expect as they proceed through various stages of document development from first draft to publication.

The first key concept to understand about OpenPOWER Foundation documents and the first decision to make when creating a new document is available document types or "Work Products". These fall into one of two categories -- Standards Track or Non-standards Track -- with the simple distinguishing factor being use. If the purpose of a document is to define a specification or standard for hardware or software, then the document is "Standards Track". Everything else is "Non-standards Track." For example, this document is a Non-Stardard Work Product as noted on the title page and the lower right corner of every subsequent page.

Non-standard Track Work Products exist simply as Work Group Notes. Their document lifecycle follows this simplified workflow:

 

Figure 1.2. Overview of Non-standard Track Work Products


Non-standard Track, Work Group Notes begin as Drafts and drop the "Draft" annotation once reviewed. As shown in the figure, the document lifecycle always returns to a "Draft" form for updates and new versions as needed.

At any step in cycle, these documents may have security classifications as Public (non-confidential), Members-only (OpenPOWER Foundation Confidential), or Work-Group only (OpenPOWER Work Group Confidential) which will in turn dictate the review context (public or private).

Standards Track Work Products begin their life as Work Group Specification and may ultimately become an OpenPOWER Standard. Their document lifecycle is defined in the following illustration:

 

Figure 1.3. Overview of Standard Track Work Products


Standard Track Work Products begin their lives as Work Group Specifications and have security classifications of Public (non-confidental), Members-only (OpenPOWER Foundation Confidental), or Work Group-only (OpenPOWER Work Group Confidential). The security classification impacts the review type -- either public or internal to the Foundation -- as appropriate. Only Work Group Specifications classified as Public may proceed into OpenPOWER Standard Documents. Confidential documents will remain Work Group Specifications.

The following sections will provide additional details about how to control the document markings and what the process that dictates those markings:


loading table of contents...