b. is doctools i suppose, format is simple enough and has many formats
to convert.
documenting commands is okay, but man pages are needed to those who
already developing something and knows what to look for. Top level docs,
like overviews, guides and manuals will make documentaion user friendly.
I found in my hard drive old circa 2002 aolserver docs, including C-API,
Tcl-API and other overviews. Not bad documentation and still apllies to
naviserver as well. It is html already, converting it to doctool does
not make sense but not using it does not make sense for me either. And
correting these old docs is not that hard, the question is: where we put
it? CVS? SF mane page? Wiki?
For the problem where do i start: man pages or Wiki or another document,
too many different ways and still it will be kept in pieces in different
places.
Bernd Eidenschink wrote:
... so it is the attitude and not format that we're fighting with.
And given the low(est possible) attitude we need to make it as
simple as possible.
correct!
b. we whould employ some stupid and easy format everybody can
handle which
is capable of expressing enough formatting rules so we can get
a decent
looking nroff and/or html
c. we should start adding (by copying or writing new) content to
those templates.
Without b. and c. we will have no usable documentation!
if we have (b) we can organize (c). we would create (d) a list of what we want
to document and volunteer for the commands we are able to document (as some
brand new commands clearly belong to a certain developer. who is fast grabs
the existing old ones and just updates them :-)).
So, the next step is (b)...
Bernd.
-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
naviserver-devel mailing list
naviserver-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/naviserver-devel
--
Vlad Seryakov
571 262-8608 office
[EMAIL PROTECTED]
http://www.crystalballinc.com/vlad/
