[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: Feedback about Release Management whitepaper
Good work, guys! Page 6 Original sentence: "The DITA 1.3 release management domain is included as metadata in the prolog of DITA topics and in the map metadata." Suggested revision: "The release management elements are available in the prolog of DITA topics and in the map metadata." Commentary: The term "domain" has very specific meaning in DITA and should be used carefully and in a technically-accurate way. Page 6 Original sentence: "Release management is an element-only domain;" Suggested revision: "Release management is an element domain;" Commentary: DITA has element domains and attribute domains. Page 6: Repeats the following sentence twice, once in "Introducing the release management domain" and again in "Release management domain elements". "All of the release management elements are optional." Page 7 -- Description of <change-item> Original sentence: "All these elements are derived from the data element." Suggested revision: "All these elements are specialized from the <data> element." Commentary: General comment: The release management elements are available in both topic and maps. The white paper mentions that, but then most of the focus in on using the elements in topics. I think this might be a little confusing, and some additional wording could clarify it. General comment: The release management domain in integrated into specific document-type shells that are provided by OASIS. It also can be integrated into any company-specific document-type shell. Should the white paper mention what topic types the domain is included in out-of-the-box? It is NOT included in the learning and training shells. General comment: Consider using the XML mention domain or at least add brackets around element names. It would make this white paper easier to read. Best,
Kris Kristen James Eberlein Chair, OASIS DITA Technical Committee Principal consultant, Eberlein Consulting www.eberleinconsulting.com +1 919 682-2290; kriseberlein (skype) On 6/8/2015 1:14 PM, Kristen James
Eberlein wrote:
FYI. |
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]