Firebird docs – how can you help ?

Rodney Gedda wrote on documentation list

I caught up with Helen this week and she mentioned help was needed
with Firebird documentation. Well, here I am. Let me know if there
is anything I can help out with.

and Paul gave him this answer:

Your helping hand is very welcome. I don’t know how much experience
you have with Firebird (I see you’ve already published about
PostgreSQL) but the most important thing at present is trying to get
some more “Using Firebird” chapters online. This manual was
open-sourced in 2005 by IBPhoenix and should become the backbone of
our documentation.

Most chapters need a lot of updating though, and some parts need to be
rewritten. The idea is to pick one chapter at a time and consult the
Firebird 1.5 and 2.0 Release Notes (and possibly other sources) to see
what needs to be updated. Ideally, each chapter should cover all
Firebird versions.

At present only 2 chapters are online – you can see them here to get
an idea:
http://www.firebirdsql.org/manual/ufb.html
http://www.firebirdsql.org/pdfmanual/Using-Firebird_(wip).pdf

We write our documentation in DocBook XML and then render it to HTML
and PDF. If it’s really impossible for you to produce DocBook XML you
can contribute in another format, but that means someone else will
have to do the conversion.

There’s a guide for docwriters here:
http://www.firebirdsql.org/manual/docwritehowto.html
http://www.firebirdsql.org/pdfmanual/Firebird-Docwriting-Guide.pdf

Please let me know how you feel about this. If you’re not familiar
with Firebird (yet) then maybe writing UFB chapters is not the right
thing to start with.

Greetings,
Paul Vinkenoog

1 Star2 Stars3 Stars4 Stars5 Stars (No Ratings Yet)
Loading...

Leave a Reply