Hi Thomas,

> I would like to offer my assistance to the Firebird Documentation Project.

Thanks! We surely can use some help :-)

> In order to make Firebird more appealing (especially) to new users, a
> complete (browseable, searchable) reference documentation is needed.

Agreed. We're far from realizing a *complete* Firebird reference, but our
first target in this area is a complete Firebird SQL Language Reference.
As I wrote to you privately, Dmitry and I intend to work on this. A lot
of material from the Firebird 2.5 Language Reference Update can be used,
but much of it will need editing.

Dmitry and I agreed on a (provisional) basic structure in December 2010.
Meanwhile, Dmitry has committed a first skeleton (with some flesh) to CVS.

> So, for now I would be thankful for any pointers where to start.

A good starting point is probably the Firebird Docbuilding Howto:
  http://www.firebirdsql.org/manual/docbuildhowto.html
  http://www.firebirdsql.org/pdfmanual/Firebird-Docbuilding-Howto.pdf

If you read the first three sections (Intro, Getting the manual module
and Building the Firebird docs), you'll have a good idea of the structure
and format of our documentation sources, and how to build the PDF/HTML
output.

After that, I suggest that you check out the sources and have a look at
the tree. The source texts are all under manual/src/docs. The skeleton
for the Language Reference is in manual/src/docs/refdocs/langref

After that... I guess it's up to you. Would you like to join Dmitry and
me in trying to get the Language Reference off the ground? Or do you
have other ideas? Please let us know!

Thanks again for your offer,

Paul Vinkenoog
Doc subproject coordinator

------------------------------------------------------------------------------
AppSumo Presents a FREE Video for the SourceForge Community by Eric 
Ries, the creator of the Lean Startup Methodology on "Lean Startup 
Secrets Revealed." This video shows you how to validate your ideas, 
optimize your ideas and identify your business strategy.
http://p.sf.net/sfu/appsumosfdev2dev
_______________________________________________
Firebird-docs mailing list
Firebird-docs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/firebird-docs

Reply via email to