From: Jerry S. <ye...@th...> - 2004-05-31 06:36:01
|
On Sat, May 29, 2004 at 06:00:30PM +0200, Michael Reinelt wrote: > Hi Xavier, Hi List, > > >>Can anyone tell me how to write documentation? I didn't follow these > >>discussions... > > > >You'll find in this tarball the documentation system. Read > >HTML/write_doc.html and HTML/test.html. > > Hey! This look cool! I really like it! Great! Congratulations! > > Is it possible to create a "standard unix man page" out of this? From my understanding, no. > What do the other guys think about it? I'm okay with it. Xavier pointed out that man pages and html pages are directed at different audiences, and I agree with him to a certain degree. I think the driver documentation can be useful in both formats, so I might look at hacking something together to make the driver docs into part of a man page. > As a last step, we have to agree on who writes what parts of the > documentation. I think I should write the drivers section, because I > know most of them by heart :-) All right. You're nominated for writing driver documentation. I've been working on what basically is a "getting started" section. I'll also work on basic program usage. What other areas need documentation? Jerry -- Jerry Seutter Email: ye...@th... Web: http://www.thegeeks.net/~yello Gallery: www.thegeeks.net/~yello/gallery (email me for username and password). |