Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > by-pkgid > 965e33040dd61030a94f0eb89877aee8 > files > 2936

howto-html-en-20080722-2mdv2010.1.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML
><HEAD
><TITLE
>Reviewing Newly Submitted Documentation</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="Linux Documentation Project Reviewer HOWTO"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Introduction"
HREF="introduction.html"><LINK
REL="NEXT"
TITLE="Reviewing Existing Documentation"
HREF="existing.html"></HEAD
><BODY
CLASS="sect1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Linux Documentation Project Reviewer HOWTO</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="introduction.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="existing.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="newdocs"
></A
>2. Reviewing Newly Submitted Documentation</H1
><P
>This review project will continue throughout the life of the LDP. The process will act as a front-end
		quality assurance review for new documentation which is submitted to the LDP. Ideally documents will be reviewed 
		within one week of their submission to the LDP. </P
><P
>Coordinators of this effort will announce to the list or notify individual review members of new document submissions. 
		The coordinators will try to funnel documents to reviewers who have knowledge in the same technical area 
		as the documentation. If the reviewer is not a technical expert in that particular area and needs technical questions 
		answered, there will be a technical expert designated who will be able to address any 
		technical issues or questions. </P
><P
>&#13;		Once reviewers have agreed to work on a document, they will have one week to complete the review. If they are
		not able to complete the review within that time frame, they will need to let the coordinator know of their difficulties so
		that the author can be notified of the problem. Because these reviews need 
		to be conducted quickly, there will be times when reviewers will be more able to accept review work.</P
><P
>When reviewing newly submitted documents, refer to the <A
HREF="techreview.html"
>Section 5</A
> and 
		<A
HREF="languagereview.html"
>Section 6</A
> portions of this guide for the types of information to verify and correct. 
		As a reviewer, you will need to check the documents out of the CVS
	  <A
NAME="AEN89"
HREF="#FTN.AEN89"
><SPAN
CLASS="footnote"
>[1]</SPAN
></A
>

and make any necessary changes. If changes are
		extensive or if the document has glaringly and fundamentally fatal errors, contact a 
		coordinator and let them know what the problems are. Once changes are made, the reviewer will update the minor 
		version number, add a new entry to the revision history, and include
		their name as an <SPAN
CLASS="QUOTE"
>"editor"</SPAN
> of the document. These
		changes will then be submitted to the CVS, and an original copy will
		be sent to the author of the document if the author does not have
		CVS access.
		</P
></DIV
><H3
CLASS="FOOTNOTES"
>Notes</H3
><TABLE
BORDER="0"
CLASS="FOOTNOTES"
WIDTH="100%"
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="5%"
><A
NAME="FTN.AEN89"
HREF="newdocs.html#AEN89"
><SPAN
CLASS="footnote"
>[1]</SPAN
></A
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="95%"
><P
>Alternatively, if you've obtained the file from the Review Coordinator, or are unfamiliar with CVS, you can return the changes to the coordinator for further handling.</P
></TD
></TR
></TABLE
><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"
><A
HREF="introduction.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="existing.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Introduction</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Reviewing Existing Documentation</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>