<< Back to man.ChinaUnix.net

Linux Documentation Project Reviewer HOWTO

Emma Jane Hogbin

David Merrill

david -AT- lupercalia.net

Joy Yokley

2004-04-19

Revision History
Revision 1.4.22004-05-24Revised by: EJH
Corrected spelling mistakes.
Revision 1.4.12004-04-19Revised by: EJH
Minor updates to the language and markup, emphasizing the reporting procedures for reviews. Also changed the order of the reviews to reflect actual procedure (technical, language and finally metadata).
Revision 1.42004-04-18Revised by: EJH
Updated the language review: clarified use of capitals, and added a new requirement that Latin abbreviations always use their English counterpart instead.
Revision 1.32004-01-31Revised by: EJH
Added the metadata and markup review information.
Revision 1.22003-11-09Revised by: TMM
Updated content, URLs, mailing lists, converted to XML.
Revision 1.12001-05-12Revised by: DCM
Minor bugfixes.
Revision 1.02001-05-01Revised by: jy
Initial release.

This document will help you review LDP documentation. It includes procedures and techniques for the review process of all new, and existing, LDP documents.


Table of Contents
1. Introduction
1.1. Copyright and License
1.2. Acknowledgements
2. Reviewing Newly Submitted Documentation
3. Reviewing Existing Documentation
3.1. Choosing a Document
3.2. License Issues
3.3. Working With the Latest Version
3.4. Picking a Review to Conduct
4. Peer Review
5. Technical Accuracy Review
6. Language Review
7. Metadata and Markup Review
7.1. Required Markup
7.2. Required Metadata
8. Reporting Your Results
A. GNU Free Documentation License
A.1. 0. PREAMBLE
A.2. 1. APPLICABILITY AND DEFINITIONS
A.3. 2. VERBATIM COPYING
A.4. 3. COPYING IN QUANTITY
A.5. 4. MODIFICATIONS
A.6. 5. COMBINING DOCUMENTS
A.7. 6. COLLECTIONS OF DOCUMENTS
A.8. 7. AGGREGATION WITH INDEPENDENT WORKS
A.9. 8. TRANSLATION
A.10. 9. TERMINATION
A.11. 10. FUTURE REVISIONS OF THIS LICENSE
A.12. Addendum