Re: [platform-doc-dev] Documentation checklist

[John Arthorne <John_Arthorne@xxxxxxxxxx>]

Thanks Michael, I have updated the checklist
based on some of these recommendations.  When you say "ensure
that each topic validates", what kind of validation are you thinking
of? Link validation?  By the way, each user guide already contains
an icon index (Reference > User interface information > Icons and
buttons).

John

Michael Behm <mbehm@xxxxxxxxxx>
Sent by: platform-doc-dev-bounces@xxxxxxxxxxx

16/05/2006 01:40 PM

Please respond to
"Platform Documentation discussions."

To	"Platform Documentation discussions." <platform-doc-dev@xxxxxxxxxxx>
cc
Subject	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="">
<td><img src="">
<td><img 
src="">
<td><img src="">
</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


_______________________________________________
platform-doc-dev mailing list
platform-doc-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-doc-dev