platform-text/3.2/doc_checklist.html - www.eclipse.org/eclipse - Git at Google

 <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
 <html>
 <head>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    <meta name="GENERATOR" content="Mozilla/4.76 [en] (Windows NT 5.0; U) [Netscape]">
    <title>3.2 Documentation Plan</title>
 </head>
 <body text="#000000" bgcolor="#FFFFFF">
 &nbsp;
 <table BORDER=0 CELLSPACING=5 CELLPADDING=2 WIDTH="100%" >
 <tr>
     <td ALIGN=LEFT VALIGN=TOP COLSPAN="2" WIDTH="100%" BGCOLOR="#595791"><font face="Arial,Helvetica"><font color="#FFFFFF">3.2 Documentation Plan</font></font></td>
 </tr>

   <tr>
     <td WIDTH="100%">
     <p>Last revised 16:55 CET May 22, 2006


       <p>This plan is under continuous refinement. Please send comments about this draft plan to the <a href="mailto:platform-text@eclipse.org">platform-text@eclipse.org</a> developer mailing list.</p>
       <p><strong>Important Notes:</strong>
       <ul>
 	      <li>all HTML editing must take place in the text editor or the HTML editor defined by Martin (TBD, see below)</li>
 	      <li>all screenshots have to be made on Johannes' machine</li>
 	      <li>make sure new additions and changes adhere to the <a href="http://wiki.eclipse.org/index.php/Eclipse_Doc_Style_Guide">Eclipse Doc Style Guide</a></li>
       </ul>
 </tr>

   <tr>
     <td WIDTH="100%">

 	<ul>
 		<li><h3><img src="http://www.eclipse.org/images/Adarrow.gif" nosave="" border="0" height="16" width="16" align="center"> User Documentation</h5>
 			<ul>
 				<li>go through all our documentation and remove all out-dated contents [Tobias, Tom]
 				<br>will discuss this in the arch call what we do with concepts and tasks section
 				<br>&rArr;all doc we ship must be up-to-date i.e. either update out-dated content or remove it
 				</li>
 				<li>check all views and editors in the new dynamic Help view: [Markus]
 					<ul>
 						<li>summary is correct </li>
 						<li>links work and make sense</li>
 					</ul>
 				</li>
 				<li>check all our dialogs and wizards that the (?) button show relvant information [Markus]</li>
 				<li>Getting Started section:<br>
 					<ul>
 						<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> make sure the Platform Getting Started section is of high-quality and easy to read [Tom]</li>
 						<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> make sure the JDT Getting Started section is of high-quality and easy to read [Martin]</li>
 						<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> test the Platform getting started: go through it step by step [Tom]</li>
 						<li>test the JDT getting started: go through it step by step [Martin]</li>
 						<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> add section about Quick views (Ctrl+O and Ctrl+T) to "Editing Java Elements" [Johannes]
 						<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> spacing between list elements [Tom]
 						<br>&rArr;Tom filed <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=141960">bug 141960</a> fixed > 20060516.
 						</li>
 						<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> inital project setup with JUnit (3.8.1) source [Martin]
 						<li>add JUnit4 doc to the JUnit section [TBD]
 					</ul>
 				</li>
 				<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> update the Tips & Tricks document [Benno with input from Martin and Dani]</li>
 				<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> complete the What's New in 3.2 section [Benno with input from Martin and Dani]</li>
 				<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> update the Readme document [JDT UI: Martin, Platform and JDT Text: Dani]</li>
 				<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> update the list of used icons [Martin]</li>
 				<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> check why source link does not work in Java Editor example [Dani]
 				<br>&rArr;see <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=120748">bug 120748</a>
 				<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> check all our examples and corresponding example descriptions [Johannes]</li>
 			</ul>
 		</li>

 		<li><h3><img src="http://www.eclipse.org/images/Adarrow.gif" nosave="" border="0" height="16" width="16" align="center"> ISV Documentation</h5>
 			<ul>
 				<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> review and complete extension point descriptions in the schemas (verify that all appear) [Tom]</li>
 				<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> verify that all APIs and extension-points appear in the corresponding programmer's guide [Tom]</li>
 				<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> verify that extension points added in 3.2 are marked "Since 3.2" [Tom]</li>
 				<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> update migration guide [Dani, Martin]</li>
 			</ul>
 		</li>

 		<li><h3><img src="http://www.eclipse.org/images/Adarrow.gif" nosave="" border="0" height="16" width="16" align="center"> Code</h5>
 			<ul>
 				<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> Javadoc [Tobias for JDT UI, Tom for Platform Text and JDT Text]</li>
 					<ul>
 						<li>verify that all APIs have Javadoc</li>
 						<li>check spelling (use American English)</li>
 						<li>new APIs have the @since3.2 tag</li>
 					</ul>
 				</li>
 				<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> spell check all *.properties files (use American English) [Tobias]
 				<br>ask Dani, he has a tool that helps with this task.
 				</li>
 				<li>verify that component.xml files are correct [Martin, <img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> Tom]</li>
 			</ul>
 		</li>

 		<li><h5>Miscellaneous</h5>
 		<ul>
 			<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> define HTML editor along with settings to be used [Martin]</li>
 			<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> ensure there are no mixed line delimiters [Dani]</li>
 			<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> redo all screen shots [Johannes]</li>
 			<li>check the whole doc with a link checker tool [Dani]</li>
 		</ul>
 		</li>
 	</ul>

 </tr>
 </table>


 <table border="0" cellpadding="2" cellspacing="5" width="100%"><tbody><tr><td colspan="4" align="left" bgcolor="#595791" valign="top" width="100%"><font face="Arial,Helvetica"><font color="#ffffff">Legend
 			</font></font></td>
 		</tr>
 		<tr>
 			<td valign="center"><img src="../images/progress.gif" nosave="" border="0" height="5" width="14" align="middle"></td>
 			<td width="50%">item is under development.</td>
 			<td valign="top"><img src="../images/glass.gif" nosave="" border="0" height="10" width="10"></td>
 			<td width="50%">item is under investigation.</td>
 		</tr>
 		<tr>
 			<td valign="center"><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"></td>
 			<td width="50%">item is finished.</td>
 			<td valign="top">( )</td>
 			<td width="50%">item is time permitted.</td>
 		</tr>
 		<tr>
 			<td valign="center"><font class="indexsub" color="#8080ff">[xyz]</font></td>
 			<td width="50%">item is deferred to or continues in xyz.</td>
 			<td valign="top"><font class="indexsub"><img src="../images/new.gif" border="0"></font></td>
 			<td width="50%">new</td>
 		</tr>
 	</tbody>
 </table>

 <br>&nbsp;
 </body>
 </html>
	<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
	<html>
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
	<meta name="GENERATOR" content="Mozilla/4.76 [en] (Windows NT 5.0; U) [Netscape]">
	<title>3.2 Documentation Plan</title>
	</head>
	<body text="#000000" bgcolor="#FFFFFF">

	<table BORDER=0 CELLSPACING=5 CELLPADDING=2 WIDTH="100%" >
	<tr>
	<td ALIGN=LEFT VALIGN=TOP COLSPAN="2" WIDTH="100%" BGCOLOR="#595791"><font face="Arial,Helvetica"><font color="#FFFFFF">3.2 Documentation Plan</font></font></td>
	</tr>

	<tr>
	<td WIDTH="100%">
	<p>Last revised 16:55 CET May 22, 2006


	<p>This plan is under continuous refinement. Please send comments about this draft plan to the <a href="mailto:platform-text@eclipse.org">platform-text@eclipse.org</a> developer mailing list.</p>
	<p><strong>Important Notes:</strong>
	<ul>
	<li>all HTML editing must take place in the text editor or the HTML editor defined by Martin (TBD, see below)</li>
	<li>all screenshots have to be made on Johannes' machine</li>
	<li>make sure new additions and changes adhere to the <a href="http://wiki.eclipse.org/index.php/Eclipse_Doc_Style_Guide">Eclipse Doc Style Guide</a></li>
	</ul>
	</tr>

	<tr>
	<td WIDTH="100%">

	<ul>
	<li><h3><img src="http://www.eclipse.org/images/Adarrow.gif" nosave="" border="0" height="16" width="16" align="center"> User Documentation</h5>
	<ul>
	<li>go through all our documentation and remove all out-dated contents [Tobias, Tom]
	<br>will discuss this in the arch call what we do with concepts and tasks section
	<br>⇒all doc we ship must be up-to-date i.e. either update out-dated content or remove it
	</li>
	<li>check all views and editors in the new dynamic Help view: [Markus]
	<ul>
	<li>summary is correct </li>
	<li>links work and make sense</li>
	</ul>
	</li>
	<li>check all our dialogs and wizards that the (?) button show relvant information [Markus]</li>
	<li>Getting Started section:<br>
	<ul>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> make sure the Platform Getting Started section is of high-quality and easy to read [Tom]</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> make sure the JDT Getting Started section is of high-quality and easy to read [Martin]</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> test the Platform getting started: go through it step by step [Tom]</li>
	<li>test the JDT getting started: go through it step by step [Martin]</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> add section about Quick views (Ctrl+O and Ctrl+T) to "Editing Java Elements" [Johannes]
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> spacing between list elements [Tom]
	<br>⇒Tom filed <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=141960">bug 141960</a> fixed > 20060516.
	</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> inital project setup with JUnit (3.8.1) source [Martin]
	<li>add JUnit4 doc to the JUnit section [TBD]
	</ul>
	</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> update the Tips & Tricks document [Benno with input from Martin and Dani]</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> complete the What's New in 3.2 section [Benno with input from Martin and Dani]</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> update the Readme document [JDT UI: Martin, Platform and JDT Text: Dani]</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> update the list of used icons [Martin]</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> check why source link does not work in Java Editor example [Dani]
	<br>⇒see <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=120748">bug 120748</a>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> check all our examples and corresponding example descriptions [Johannes]</li>
	</ul>
	</li>

	<li><h3><img src="http://www.eclipse.org/images/Adarrow.gif" nosave="" border="0" height="16" width="16" align="center"> ISV Documentation</h5>
	<ul>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> review and complete extension point descriptions in the schemas (verify that all appear) [Tom]</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> verify that all APIs and extension-points appear in the corresponding programmer's guide [Tom]</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> verify that extension points added in 3.2 are marked "Since 3.2" [Tom]</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> update migration guide [Dani, Martin]</li>
	</ul>
	</li>

	<li><h3><img src="http://www.eclipse.org/images/Adarrow.gif" nosave="" border="0" height="16" width="16" align="center"> Code</h5>
	<ul>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> Javadoc [Tobias for JDT UI, Tom for Platform Text and JDT Text]</li>
	<ul>
	<li>verify that all APIs have Javadoc</li>
	<li>check spelling (use American English)</li>
	<li>new APIs have the @since3.2 tag</li>
	</ul>
	</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> spell check all *.properties files (use American English) [Tobias]
	<br>ask Dani, he has a tool that helps with this task.
	</li>
	<li>verify that component.xml files are correct [Martin, <img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> Tom]</li>
	</ul>
	</li>

	<li><h5>Miscellaneous</h5>
	<ul>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> define HTML editor along with settings to be used [Martin]</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> ensure there are no mixed line delimiters [Dani]</li>
	<li><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"> redo all screen shots [Johannes]</li>
	<li>check the whole doc with a link checker tool [Dani]</li>
	</ul>
	</li>
	</ul>

	</tr>
	</table>


	<table border="0" cellpadding="2" cellspacing="5" width="100%"><tbody><tr><td colspan="4" align="left" bgcolor="#595791" valign="top" width="100%"><font face="Arial,Helvetica"><font color="#ffffff">Legend
	</font></font></td>
	</tr>
	<tr>
	<td valign="center"><img src="../images/progress.gif" nosave="" border="0" height="5" width="14" align="middle"></td>
	<td width="50%">item is under development.</td>
	<td valign="top"><img src="../images/glass.gif" nosave="" border="0" height="10" width="10"></td>
	<td width="50%">item is under investigation.</td>
	</tr>
	<tr>
	<td valign="center"><img src="../images/ok.gif" nosave="" border="0" height="10" width="10"></td>
	<td width="50%">item is finished.</td>
	<td valign="top">( )</td>
	<td width="50%">item is time permitted.</td>
	</tr>
	<tr>
	<td valign="center"><font class="indexsub" color="#8080ff">[xyz]</font></td>
	<td width="50%">item is deferred to or continues in xyz.</td>
	<td valign="top"><font class="indexsub"><img src="../images/new.gif" border="0"></font></td>
	<td width="50%">new</td>
	</tr>
	</tbody>
	</table>

	<br>
	</body>
	</html>