Publishing OpenPOWER DocumentsThe 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. The section 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 specification publish.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.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: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.Non-standard Track Work Products exist simply as Work Group Notes. Their document
lifecycle follows this simplified workflow:Non-standard Track, Work Group Notes begin as Drafts and drop the "Draft" annotation once reviewed. Like
Standard Track Work Products, they 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).Once these decisions have been made, then they can be reflected into the document in the following ways:The document Work Product type is defined in the document pom.xml file with the
<workProduct> variable. Valid settings are workgroupNotes,
workgroupSpecification, candidateStandard, and openpowerStandard.
Select the appropriate setting in the following section:
workgroupNotes
]]>The document security is set in the document pom.xml file with the
<security> variable. Valid settings are public,
foundationConfidential, and workgroupConfidential.
Select the appropriate setting in the following section:
workgroupConfidential
]]>The document work flow status is set in the document pom.xml file with the
<documentStatus> variable. Valid settings are draft,
review, and published.
Select the appropriate setting in the following section:
draft
]]>The final place to make updates to a new document is in the <abstract> section of
the bk_main.xml file for the document. This section needs to be updated with the appropriate
work group information and document information. Typical text appears as follows:
The purpose of the Master Template Guide document is to provide a guide
for OpenPOWER documentation writers. As such, it provides directions, policies,
references, and examples of the XML Docbook environment. It is intended to be
used both in final product form (PDF and html) as a document and in source form
as a template for new documents.This document is a Non-standard Track, Work Group Note work product
owned by the System Software Workgroup and handled in compliance with the
requirements outlined in the OpenPOWER Foundation Work Group (WG)
Process document.]]>As stated in the comment text of the book file, the first paragraph provides a typical abstract
statement about your particular document. The second paragraph provides more structured
text which should be updated with the appropriate Work Group name, Work Product type,
and Work Product process. The rest of the information in this paragraph should remain as-is.