Members of the DITA TC,
Per the TC's submission request [1], please find the attached starter document for:
Lightweight DITA: An Introduction Version 1.0
WP-abbrev: LwDITA
We expect this Work Product to be published at:
As you will be publishing from DITA source per the usual practice, note the following:
- As per our usual practice, I prepared this to show the cover pages as it would be published rather than sending the usual working draft template. This is simply the 'style sheet' to you all as it were.
- I have handled the filenames assuming you approve the Committee Note directly. If you want to send it out for public review, I'll only need the Committee Spec Public Review Draft copy. We've eliminated the duplicate cnd01/csprd01 copies the way we used to do it. In that case, the file names would use cnprd01 rather than cn01 and the stage would be
Committee Note Draft 01 /
Public Review Draft 01
- I have left all hyperlinks on this template underlined so they stand out. In your published version, they should not be underlined.
- I have added a proposed link under Additional artifacts for the DITA source file. It is a suggested file name so feel free to change that.
Please let me know if anything here fails to meet your expectations.
Further revisions to this Work Product must be maintained in Working Drafts, following procedures detailed in the OASIS TC Administration How-to Guide [2].
Working Drafts should be made available by uploading the document(s) to the TC's Kavi document repository, or to the TC's Subversion (SVN) repository, if SVN has been activated for your TC [3]. TCs are encouraged to use ZIP packaging when the WD releases contain multiple files (and directories).
For each WD revision, you will need to:
1) increment the Working Draft revision (number) from 01 to 02, 03, 04 etc., as successive Working Drafts are produced; the revision number needs to be updated at the top of the document in the stage identifier (Working Draft ##) and in the document identifier within the page footer.
2) supply the relevant publication/release/upload date for each successive Working Draft instance, using the prescribed date format: DD Month YYYY; the date needs to be updated at the top of the document (just below the stage identifier, Working Draft ##) and in the page footer.
3) provide suitable text for a document Abstract, updating this summary with successive revisions to provide an accurate description of the subject matter, goals, scope, etc.
4) keep the Acknowledgments (Appendix A) and Revision History (Appendix C) up-to-date with each WD revision.
5) consult the OASIS Naming Directives document when creating new artifacts that may be part of the Work Product (e.g., image files, XML schemas), observing the rules for name characters in files and proposed directories, and for proposed URIs/namespaces [4].
When the TC votes [5] to approve a Working Draft as a Committee Draft (CSD or CND), the Chair or other designated person must submit a "Committee Specification Draft Creation and Upload Request" accessible on the TC Administration Requests Page [6].
Upon receipt of this form, the TC Administrator will QC and process the Work Product for official publication in the OASIS Library (
http://docs.oasis-open.org/) as a Committee Draft, including addition of the requisite cover page metadata and other boilerplate information.
A quality checklist of commonly-occurring issues found in draft specifications is available at
https://www.oasis-open.org/committees/download.php/54999/latest. This checklist was developed by the OASIS Technical Advisory Board (TAB) and is used to provide feedback to TC's when a document goes out for its first public review. The document can help spec editors and anticipate and address a number of routine problems.
=========== References:
[2] Developing Committee Specifications and Notes
Starting a Working Draft
[3] SVN Version control, via Tools
[4] OASIS Naming Directives
[5] Approval of a WD as a CD (CSD or CND)
[6] TC Administration Requests Page, see Committee Specification Draft
Creation / Upload Request
--
/chet
----------------
Chet Ensign
Director of Standards Development and TC Administration
OASIS: Advancing open standards for the information society
http://www.oasis-open.orgPrimary: +1 973-996-2298
Mobile: +1 201-341-1393