This material has been proposed but no author has committed to developing it.
This material has been assigned to an author (or authors). These authors have not yet started composing it.
This material is under construction. Authors are composing it.
This material represents a complete draft ready for editorial review.
This material is undergoing potentially substantial edits. Editors are suggesting revisions to organization, flow, and argument. They may ask authors to add additional material.
This material requires examination by a subject matter expert. Authors and editors are locating one, and that outside reader is assessing the material. Not all material requires this type of review.
This material requires basic copy editing, which may include: standardizing voice and tone, eliminating grammatical issues, ensuring consistent punctuation, etc.
This material requires markup in Asciidoc.
Authors, editors, and anyone else working on the project is reviewing the material one final time.
Material is complete. Any proposed edits or additions should be submitted as new material and assigned an author.
- Authors have suggested an outline of proposed material
- One or more editors have reviewed and and approved the authors' proposed outline
- Drafted material adequately corresponds to proposed outline
- Author has indicated that draft is ready for review by an editor
- Material submitted is a complete draft
- Authors have submitted text in English
- Authors have submitted all art and indicated proper attribution
- Material passes a basic plagiarism check
- Material is logically and coherently organized
- Sidebars (if any) are appropriately formatted
- Art (if any) is appropriately formatted
- Material is stylistically consistent
- Accuracy of subject matter has been confirmed
- Authors have reviewed comments from subject matter experts and resolved all outstanding issues
- Material has been edited for grammar and spelling
- Authors have reviewed all proposed edits, have addressed outstanding questions from editors, and have approved all changes
- Technical accuracy of materials has been confirmed
- Material has been properly and completely typeset in Asciidoc
- Authors and technical editors have completely resolved all oustanding issues and comments
- Material has been proofread one final time for spelling and grammatical errors
- Authors have acknowledged and/or approved all final changes
Each Asciidoc (.adoc) file has a standard header following this format:
= Chapter Title Case Like This // Authors: Firstname Lastname [email protected], Their Coauthor [email protected] // Updated: YYYY-MM-DD // Versions: [1.99|2.0|X.Y] // Status: [DRAFT|PUBLISHED]
The first line is an H1 and title of the chapter, as it should appear in the generated Table of Contents.
The second line lists one or more authors and their email addresses. This line is commented out so that it doesn't appear at the top of the chapter, which currently creates some confusion with the built document.
Third line is the latest date of this file.
Fourth line specifies which version or versions this file is associated with.
Fifth line defines if this file is still a draft or should be collected for publishing by any building-and-publishing tools.