475 lines
6.2 KiB
HTML
475 lines
6.2 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<HTML
|
|
><HEAD
|
|
><TITLE
|
|
>Linux Documentation Project Reviewer HOWTO</TITLE
|
|
><META
|
|
NAME="GENERATOR"
|
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
|
|
REL="NEXT"
|
|
TITLE="Introduction"
|
|
HREF="introduction.html"></HEAD
|
|
><BODY
|
|
CLASS="article"
|
|
BGCOLOR="#FFFFFF"
|
|
TEXT="#000000"
|
|
LINK="#0000FF"
|
|
VLINK="#840084"
|
|
ALINK="#0000FF"
|
|
><DIV
|
|
CLASS="ARTICLE"
|
|
><DIV
|
|
CLASS="TITLEPAGE"
|
|
><H1
|
|
CLASS="title"
|
|
><A
|
|
NAME="AEN2"
|
|
></A
|
|
>Linux Documentation Project Reviewer HOWTO</H1
|
|
><H3
|
|
CLASS="author"
|
|
><A
|
|
NAME="AEN4"
|
|
>Emma Jane Hogbin</A
|
|
></H3
|
|
><DIV
|
|
CLASS="affiliation"
|
|
><SPAN
|
|
CLASS="orgname"
|
|
><A
|
|
HREF="http://www.xtrinsic.com"
|
|
TARGET="_top"
|
|
>xtrinsic</A
|
|
><BR></SPAN
|
|
><DIV
|
|
CLASS="address"
|
|
><P
|
|
CLASS="address"
|
|
><TT
|
|
CLASS="email"
|
|
><<A
|
|
HREF="mailto:emmajane@xtrinsic.com"
|
|
>emmajane@xtrinsic.com</A
|
|
>></TT
|
|
></P
|
|
></DIV
|
|
></DIV
|
|
><H3
|
|
CLASS="author"
|
|
><A
|
|
NAME="AEN12"
|
|
>David Merrill</A
|
|
></H3
|
|
><DIV
|
|
CLASS="affiliation"
|
|
><DIV
|
|
CLASS="address"
|
|
><P
|
|
CLASS="address"
|
|
>david -AT- lupercalia.net</P
|
|
></DIV
|
|
></DIV
|
|
><H3
|
|
CLASS="author"
|
|
><A
|
|
NAME="AEN17"
|
|
>Joy Yokley</A
|
|
></H3
|
|
><DIV
|
|
CLASS="affiliation"
|
|
><DIV
|
|
CLASS="address"
|
|
><P
|
|
CLASS="address"
|
|
><TT
|
|
CLASS="email"
|
|
><<A
|
|
HREF="mailto:jyokley@us.ibm.com"
|
|
>jyokley@us.ibm.com</A
|
|
>></TT
|
|
></P
|
|
></DIV
|
|
></DIV
|
|
><P
|
|
CLASS="pubdate"
|
|
>2004-04-19<BR></P
|
|
><DIV
|
|
CLASS="revhistory"
|
|
><TABLE
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
><TR
|
|
><TH
|
|
ALIGN="LEFT"
|
|
VALIGN="TOP"
|
|
COLSPAN="3"
|
|
><B
|
|
>Revision History</B
|
|
></TH
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>Revision 1.4.2</TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>2004-05-24</TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>Revised by: EJH</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
COLSPAN="3"
|
|
>Corrected spelling mistakes.</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>Revision 1.4.1</TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>2004-04-19</TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>Revised by: EJH</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
COLSPAN="3"
|
|
>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).</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>Revision 1.4</TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>2004-04-18</TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>Revised by: EJH</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
COLSPAN="3"
|
|
>Updated the language review: clarified use of capitals, and
|
|
added a new requirement that Latin abbreviations always use their
|
|
English counterpart instead.</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>Revision 1.3</TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>2004-01-31</TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>Revised by: EJH</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
COLSPAN="3"
|
|
>Added the metadata and markup review information.</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>Revision 1.2</TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>2003-11-09</TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>Revised by: TMM</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
COLSPAN="3"
|
|
>Updated content, URLs, mailing lists, converted to XML.</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>Revision 1.1</TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>2001-05-12</TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>Revised by: DCM</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
COLSPAN="3"
|
|
>Minor bugfixes.</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>Revision 1.0</TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>2001-05-01</TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
>Revised by: jy</TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
COLSPAN="3"
|
|
>Initial release.</TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
><DIV
|
|
><DIV
|
|
CLASS="abstract"
|
|
><A
|
|
NAME="AEN24"
|
|
></A
|
|
><P
|
|
></P
|
|
><P
|
|
>This document will help you review LDP documentation.
|
|
It includes procedures and techniques for the review process
|
|
of all new, and existing, LDP documents.</P
|
|
><P
|
|
></P
|
|
></DIV
|
|
></DIV
|
|
><HR></DIV
|
|
><DIV
|
|
CLASS="TOC"
|
|
><DL
|
|
><DT
|
|
><B
|
|
>Table of Contents</B
|
|
></DT
|
|
><DT
|
|
>1. <A
|
|
HREF="introduction.html"
|
|
>Introduction</A
|
|
></DT
|
|
><DD
|
|
><DL
|
|
><DT
|
|
>1.1. <A
|
|
HREF="introduction.html#copyright"
|
|
>Copyright and License</A
|
|
></DT
|
|
><DT
|
|
>1.2. <A
|
|
HREF="introduction.html#acknowledgements"
|
|
>Acknowledgements</A
|
|
></DT
|
|
></DL
|
|
></DD
|
|
><DT
|
|
>2. <A
|
|
HREF="newdocs.html"
|
|
>Reviewing Newly Submitted Documentation</A
|
|
></DT
|
|
><DT
|
|
>3. <A
|
|
HREF="existing.html"
|
|
>Reviewing Existing Documentation</A
|
|
></DT
|
|
><DD
|
|
><DL
|
|
><DT
|
|
>3.1. <A
|
|
HREF="existing.html#picking"
|
|
>Choosing a Document</A
|
|
></DT
|
|
><DT
|
|
>3.2. <A
|
|
HREF="existing.html#licenseissues"
|
|
>License Issues</A
|
|
></DT
|
|
><DT
|
|
>3.3. <A
|
|
HREF="existing.html#newversion"
|
|
>Working With the Latest Version</A
|
|
></DT
|
|
><DT
|
|
>3.4. <A
|
|
HREF="existing.html#pickatype"
|
|
>Picking a Review to Conduct</A
|
|
></DT
|
|
></DL
|
|
></DD
|
|
><DT
|
|
>4. <A
|
|
HREF="peerreview.html"
|
|
>Peer Review</A
|
|
></DT
|
|
><DT
|
|
>5. <A
|
|
HREF="techreview.html"
|
|
>Technical Accuracy Review</A
|
|
></DT
|
|
><DT
|
|
>6. <A
|
|
HREF="languagereview.html"
|
|
>Language Review</A
|
|
></DT
|
|
><DT
|
|
>7. <A
|
|
HREF="metadatareview.html"
|
|
>Metadata and Markup Review</A
|
|
></DT
|
|
><DD
|
|
><DL
|
|
><DT
|
|
>7.1. <A
|
|
HREF="metadatareview.html#requiredmarkup"
|
|
>Required Markup</A
|
|
></DT
|
|
><DT
|
|
>7.2. <A
|
|
HREF="metadatareview.html#requiredmetadata"
|
|
>Required Metadata</A
|
|
></DT
|
|
></DL
|
|
></DD
|
|
><DT
|
|
>8. <A
|
|
HREF="reporting.html"
|
|
>Reporting Your Results</A
|
|
></DT
|
|
><DT
|
|
>A. <A
|
|
HREF="fdl.html"
|
|
>GNU Free Documentation License</A
|
|
></DT
|
|
><DD
|
|
><DL
|
|
><DT
|
|
>A.1. <A
|
|
HREF="fdl-preamble.html"
|
|
>0. PREAMBLE</A
|
|
></DT
|
|
><DT
|
|
>A.2. <A
|
|
HREF="fdl-section1.html"
|
|
>1. APPLICABILITY AND DEFINITIONS</A
|
|
></DT
|
|
><DT
|
|
>A.3. <A
|
|
HREF="fdl-section2.html"
|
|
>2. VERBATIM COPYING</A
|
|
></DT
|
|
><DT
|
|
>A.4. <A
|
|
HREF="fdl-section3.html"
|
|
>3. COPYING IN QUANTITY</A
|
|
></DT
|
|
><DT
|
|
>A.5. <A
|
|
HREF="fdl-section4.html"
|
|
>4. MODIFICATIONS</A
|
|
></DT
|
|
><DT
|
|
>A.6. <A
|
|
HREF="fdl-section5.html"
|
|
>5. COMBINING DOCUMENTS</A
|
|
></DT
|
|
><DT
|
|
>A.7. <A
|
|
HREF="fdl-section6.html"
|
|
>6. COLLECTIONS OF DOCUMENTS</A
|
|
></DT
|
|
><DT
|
|
>A.8. <A
|
|
HREF="fdl-section7.html"
|
|
>7. AGGREGATION WITH INDEPENDENT WORKS</A
|
|
></DT
|
|
><DT
|
|
>A.9. <A
|
|
HREF="fdl-section8.html"
|
|
>8. TRANSLATION</A
|
|
></DT
|
|
><DT
|
|
>A.10. <A
|
|
HREF="fdl-section9.html"
|
|
>9. TERMINATION</A
|
|
></DT
|
|
><DT
|
|
>A.11. <A
|
|
HREF="fdl-section10.html"
|
|
>10. FUTURE REVISIONS OF THIS LICENSE</A
|
|
></DT
|
|
><DT
|
|
>A.12. <A
|
|
HREF="fdl-using.html"
|
|
>Addendum</A
|
|
></DT
|
|
></DL
|
|
></DD
|
|
></DL
|
|
></DIV
|
|
></DIV
|
|
><DIV
|
|
CLASS="NAVFOOTER"
|
|
><HR
|
|
ALIGN="LEFT"
|
|
WIDTH="100%"><TABLE
|
|
SUMMARY="Footer navigation table"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
CELLPADDING="0"
|
|
CELLSPACING="0"
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
> </TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
> </TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="introduction.html"
|
|
ACCESSKEY="N"
|
|
>Next</A
|
|
></TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
> </TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
> </TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
>Introduction</TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
></BODY
|
|
></HTML
|
|
> |