[Firebird-docs] A how-to on writing Firebird docs?

[Paul V. <pa...@vi...>]

Hello all,

This message is intended for everybody who is planning or considering
to help with the Firebird docs.

As said earlier, practically everything will have to be written from
scratch. Helen Borrie, who has lots of experience with doc writing,
advised us to develop a how-to on writing Firebird docs.

I think this is a good idea, but I would like to know if there's
anybody out there who's really going to write something in the next
couple of months, and thinks this might be helpful. Or who would be
willing to contribute to such a how-to, even if only by discussing
here what should go in it.

Or... is there anybody out there now saying "Yes, I'd like to help
writing docs and I have the time too, but I need a place to start, I
need guidelines or else I don't know how or where to begin" ?

You see, no matter how good the idea is, it _is_ another document to
write. Is it worth investing time in a howto at this stage if noone is
going to write "real" docs anyway? Or if the few people who may start
soon don't really feel they need one?

Myself I wanted to start with the API documenation a month ago, but
due to a lot of extra work I just didn't find the time. Hopefully
things will be better soon, but I'll never have a _lot_ of time.
That's why I want to spend my doc writing hours in the most effective
way.


Greetings, and good wheather upon you all,
Paul Vinkenoog