[vorbis-dev] who needs documentation?

[Graham Mitchell]

Okay, my responsibilities at school have recently eased up a bit, and I might 
have some actual free time over the coming months.  So I'd like to volunteer 
my services to write some needed documentation, tutorials, FAQs, etc.

I am "fluent" in C and C++ and am not bad at Perl.  I have been told I'm good 
at explaining things.  I am anal-retentive about grammar, syntax, and 
spelling.  I proofread compulsively.

On the other hand, I didn't pay enough attention in linear algebra, so I 
don't remember how to multiply two non-square matrices, much less what a(n) 
MDCT is.  So API references are probably out.  Also I have no experience with 
formats other than plain text and HTML, which means man pages, info pages, 
DocBook or what-have-you would be prohibitively difficult.

End-user documentation may be the place for me.  For an example of my "work", 
see [ http://grahammitchell.net/files/copyrand.txt ], which is the 
documentation for a utility I wrote for my own use nearly four years ago and 
subsequently released.

Most of the other programs listed at [ http://grahammitchell.net/code.html ] 
also have documentation included in the zipfile/tarball, if someone wants to 
read other examples.

I am the sort of person who will say "No" at first rather than accept an 
assignment and not finish it.  Which is to say, if I refuse an opportunity, 
it's probably because I know I would have done a crappy job or not had enough 
free time to do it anyway.

I am also the sort of person who's perfectly happy writing a long FAQ and 
then letting someone else hack it up, so that the final product might be 
quite different from my suggestions.  In fact, since my free time varies 
greatly with the time of year, I can't promise to *maintain* any of the 
documentation I do write.

With all that out of the way, suggestions in this forum are welcome (if 
that's acceptable), or by personal email.  If I get several things on my 
plate, I'll announce that I'm "booked" as well.


-- 
Graham Mitchell - computer science teacher, Leander High School
Man:	 What man?
Praline: The man from the cat detector van.
Man:	 Loony detector van you mean.
Praline: It's people like you what cause unrest.

--- >8 ----
List archives:  http://www.xiph.org/archives/
Ogg project homepage: http://www.xiph.org/ogg/
To unsubscribe from this list, send a message to 'vorbis-dev-request at xiph.org'
containing only the word 'unsubscribe' in the body.  No subject is needed.
Unsubscribe messages sent to the list will be ignored/filtered.