OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

dita-lightweight-dita message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: OASIS policy for handling public review comments / What needs to be done for the "Lightweight DITA: An Introduction" review?

OASIS has very clear policies for handling public review comments. (These rules apply whether or not the review of is a standard work track product (spec) or a non-standards track work product (committee note).

You can view the rules at https://www.oasis-open.org/policies-guidelines/tc-process-2017-05-26#publicReview , but here is a brief summary:

  1. All review comments (e-mails to TC list or e-mails to dita-comment) must be formally acknowledged.
  2. All review comments must be formally tracked.
  3. At the close of the review, the TC must post to its e-mail list how it handled each review comment.

As spec editors, Robert and I handled the tracking for the DITA 1.2 and 1.3 releases in several ways:

When you do a public review of a document, you need to track the changes that you make to the source -- especially to determine whether or not they are "material." If changes are "material," then the document needs to go out for additional public reviews until no more material changes are made.

My personal opinion: Using a DITA topic to track comments, their resolution, etc. was the best approach. The only drawback was that we had to generate output in order for TC members to see work in progress. Robert, your thoughts?

Obviously, there is work to be assigned and processes to be clarified:

  • Who acknowledges each comment on the dita-comment list?
  • Who maintains the comment resolution log?
  • Whether to use a Wiki page or DITA topic for the comment resolution log?
  • Which comments are brought to the TC for discussion? Which comments will editors immediately fix and then notify the TC?
  • Does the subcommittee want to play an intervening role? For example, does subcommittee make tentative comment resolution and then refer to the TC? (Note: This will take more time.)

Lots to talk over and digest. I apologize in advance for the lengthy e-mail, but I don't see how I could have made it shorter.


Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
+1 919 682-2290; kriseberlein (skype)

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]