DOCUMENTATION style guide?

["Kenneth R. Kinder" <Ken KenAndTed com>]

-----BEGIN PGP SIGNED MESSAGE-----


I couldn't help but notice there is no documentation style guide...

Well, there should be!  :)

Maybe we could get one together, eh folks?  Let's start by being abstract. 
 I, for one, think an APPLICATION'S documentation should have at least a...

 * table of contents
 * a tutorial, if program is sizable
 * reference of all menu items
 * help on every major dialog box
 * contact information (prog URL, about stuff, ect)
 * glossary (if appropriate)

API reference should have...

 * Summary of purpose for each function
 * syntax of function
 * argument reference
 * notes and other information
 * examples
 * links to other related functions

Thoughts anyone?

- -- 

 H3C-N--C=N      | Kenneth R. Kinder, aka Bouncing     
"code=caffiene*hours"
      \==/       | Ken@KenAndTed.com  http://www.KenAndTed.com/KensBookmark
/
    O=<__>N-C3H  |
  H3C-N \\O      |                   Ken & Ted's Software
_________________| http://www.KenAndTed.com/          
Software@KenAndTed.com






-----BEGIN PGP SIGNATURE-----
Version: 2.6.3i
Charset: noconv

iQCVAwUBNVEt2SUbN6MeoG1RAQEYQAP/f9xtI88wLB57g8O2n1f8mkuP70hPISUj
0X4Bv98qagVQyfuvPBa+zAVrv/Jd5JkLWRHas6lSgz+1ApFAiWjPGK8QgSvqZsrt
QjOqrd6QpYwbNK4TmnzsseIBFsjP20PtXTUpOCqf7s10MYMbGD8aXs+5lXjbwA54
Ug89EmlJl4g=
=WxBG
-----END PGP SIGNATURE-----