Skip site navigation (1) Skip section navigation (2)

Re: Documentation organization

From: Thomas Lockhart <lockhart(at)alumni(dot)caltech(dot)edu>
To: Peter Eisentraut <peter_e(at)gmx(dot)net>
Cc: pgsql-docs(at)postgresql(dot)org
Subject: Re: Documentation organization
Date: 2000-06-29 17:56:05
Message-ID: 395B8DB5.6C062013@alumni.caltech.edu (view raw or flat)
Thread:
Lists: pgsql-docs
> Comments? Suggestions? Better ideas?

I can't argue with the statement that the overall organization is about
right. :)

I'm not sure how "set" will differ from "part" when it comes time to
split up the hardcopy, but it might be pretty easy (it partly depends on
how the RTF assigns the styles). Do you want to try to do
"postgres.sgml" as a set-based doc and see how it works? Or modify it
and commit it as postgres-set.sgml so we can carry along both until the
kinks are worked out?

> Reference pages should be placed at the end of each document that they 
> fit into. E.g., postmaster in Administorator's guide, psql in 
> Interfaces, etc.

Hmm. I think that this might be OK, but I'm worried that there will be
some "grey area" categories that make it hard to figure out which doc to
look in for the reference. psql is a good example: why should it be in
"Interfaces" (coding interfaces?) instead of "Applications"?

But we can also carry along a separate "references" document which
*does* integrate them all, as well as including them at the end of each
relevant doc. I'm pretty sure that if I had to choose one or the other
I'd choose to put them together.

                  - Thomas

In response to

Responses

pgsql-docs by date

Next:From: Peter EisentrautDate: 2000-06-30 16:22:36
Subject: Re: Documentation organization
Previous:From: Thomas LockhartDate: 2000-06-29 17:47:16
Subject: Re: Database recovery

Privacy Policy | About PostgreSQL
Copyright © 1996-2014 The PostgreSQL Global Development Group