[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
Re: [platform-doc-dev] Documentation checklist
|
It looks like a very good list. I would suggest adding:
-Ensure that each topic validates and has been spell-checked.
-Ensure that the contents of the topic are appropriate
for the category the topic is in. For example,
concepts/chelpview.htm really is more reference than concept.
-Ensure that path names, instructions related to accessing help,
and instructions relating to the secondary mouse key are
(preferably) marked up in conditional text or (at a minimum)
extensive enough to cover the standard widget sets:
(F1 for Windows, Ctrl+F1 for Linux GTK, or Help key for Macs).
-Consider searching the existing help topics for other pages
that relate to the topic you are writing about. For example,
if you are adding a topic about the Help view, search for
"help" to see which topics would make useful "Related <topic>"
links.
-Consider adding a graphic of any icons you discuss in your
topics. To get a visual list of all the icons currently in
the documentation's images directory, sort the images by
size and put the 1K file names into an HTML file in a table
that has a format similar to the following:
<table border="0">
<tr>
<td><img src="<CVS>/images/drop_top_source.png"><br>drop_top_source.png</td>
<td><img src="<CVS>/images/ref-2.png"><br>ref-2.png</td>
<td><img
src="<CVS>/images/drop_bottom_source.png"><br>drop_bottom_source.png</td>
<td><img src="<CVS>/images/drop_offscreen.png"><br>drop_offscreen.png</td>
</tr>
<tr>
...
</tr>
</table>
John Arthorne wrote:
The platform text team has a handy checklist that they use to ensure
that all their component documentation is complete. This is a useful
resource, so I have added it to the documentation wiki. Feel free to
add/update with any missing points:
http://wiki.eclipse.org/index.php/Eclipse_Doc_Checklist
