[ibis-editorial] IBIS Version 6.2 Process

  • From: "Bob Ross" <bob@xxxxxxxxxxxxxxxxx>
  • To: <ibis-editorial@xxxxxxxxxxxxx>
  • Date: Tue, 26 Jul 2016 09:50:47 -0700

Editorial Group Members,

Our original goal was to do a terminology cleanup.  We still want to
do this and can use draft documents to identify the changes.  These
changes may include redoing the figures, where needed.

However, because we are now introducing new technical changes,
and re-writing some existing paragraphs, we need to follow the formal
process or practice that we have used in the past releases.

----

Start again with the Version 6.1 document as the baseline

1. Make the known_issues.txt corrections and review that we are all
in agreement.  (As a first step, we are still in sync with the page
numbers.)
http://www.ibis.org/ver6.1/

2. Add only the approved versions of new BIRDs that have been fully vetted.
- Technical changes
- Major or even some minor editorial changes

We need to keep a historical record of changes, and have a reference for
the parser developer for technical changes

Note, in the past we have discovered new interaction issues and have
needed to generate a new BIRD or two to resolve them.

However, after this is done we might also make a terminology pass to
be consistent with some new BIRDs.

3. Back-fill other information such as 3.1 Keyword Hierarchy, if not stated
in the BIRDs

We may need to update some IBIS-AMI table(s) based on BIRD179.

4. Add Section 2 for the new list of BIRDs that are included.

5. Do some final cleanup such as making line-feeds and vertical spacing
consistent.  Also, in this process we might discover some minor grammatical
errors (spelling, punctuation, etc.)

6. A possible unknown is if many figures need to be revised.  If so,
generate
new figures.

7.  When we have a good draft for the final version, we might have a good
idea when it will be officially approved.  We can edit
- search and replace September 11, 2015 with the new date
- search for 2015 or for [Copyright] or [Date] keyword to insert the new
year
- change [IBIS Ver] 6.1 to 6.2 and AMI_Version to 6.2 in most places.  Be
careful
because we may be purposefully be referring to an older version is a few
locations.

-------

This careful process assures that we have meaningful version control for
changes,
that only fully vetted, approved material is included, and that we minimize
mistakes.

Currently, Michael Mirmak is the official editor and the person who should
be
managing this process.

Bob

--

Bob Ross
Teraspeed Labs
http://www.teraspeedlabs.com
bob@xxxxxxxxxxxxxxxxx
Direct: 503-246-8048
Office: 971-279-5325




Other related posts:

  • » [ibis-editorial] IBIS Version 6.2 Process - Bob Ross