Re: [Firebird-docs] Which kind of docs?

[Tilo M. <tm...@al...>]

Hi,

"Paul Vinkenoog" <pa...@vi...> schrieb im Newsbeitrag
news:Pin...@s4......

[snip]

> Personally, I find it most important to produce a comprehensive core
> documentation set, more or less like the PDF books that Borland ships
> with InterBase. Such a set could (should?) contain:
>
> - a DDL guide
> - a DML guide
> - an SQL reference
> - an API guide
> - a Programmer's Guide
> - ...
> - ...

Why not take a look at PostgreSQL:
http://www.postgresql.org/docs/7.3/static/index.html
- A tutorial, great for newbies with databases in general and Firebird in
particular
- From the users point of view, DML, DDL
- From the admin point of view, setup, optimize, deploy
- Programmer Guide, API
- SQL Reference
- Developer Guide, also with infos for people willing to contribute to Fb

> For now, the free Borland IB6 beta docs are still very usable with
> Firebird, provided you also have the Release Notes etc. that come with
> the consecutive Firebird versions. But InterBase and Firebird _will_
> diverge more and more, so in a couple of years' time this is really
> going to be a problem.

Fully agreed.

> Since I've been playing around with the API lately I would like to
> start with an API Guide myself. But I realize that this is not the
> most urgently needed guide, so I might be persuaded into writing
> something else instead.

As I stated elsewhere, I will not have much spare time available for active
contribution but are willing to discuss things and help with the Docbook
setup itself.

> Important
> =========
> The Borland InterBase 6 Beta Docs are free in the sense that you don't
> have to pay for them - but they *are* copyrighted. This implies that
> it's perfectly OK to use all kinds of _INFORMATION_ we find in those
> docs, but it's illegal to copy _TEXT_ (even portions) from them.
> We'd better keep that in mind whilst writing our docs, or else!

Agreed.

> Greetings,
> Paul Vinkenoog

Regards,
Tilo