Documentation and explanatory diagrams - Mailing list pgsql-docs

From Rafael Martinez
Subject Documentation and explanatory diagrams
Date
Msg-id 4BB9E69F.9080203@usit.uio.no
Whole thread Raw
Responses Re: Documentation and explanatory diagrams
Re: Documentation and explanatory diagrams
List pgsql-docs
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hello

I am wondering if we have ever evaluated the use of explanatory diagrams
in the PostgreSQL documentation.

I have always thought that a good diagram is worth a thousand words. I
think the PostgreSQL manual would improve its quality if we get some
good diagrams on the right places.

They will help novice and advanced users who are not involved in the
development of PostgreSQL, to get a quick overview  of some central
components in a PostgreSQL system when they read the documentation.

Some of the possible diagrams that come to my mind in none particular
order are:

 - PITR
 - Streaming Replication
 - Hot Standby
 - Write-Ahead Log
 - System Catalogs
 - Architectural Fundamentals overview
 - PostgreSQL server overview
 - Disk layout
 - Database Roles and Privileges
 - Database Physical Storage
 - Security and authentication

What do you think about the idea? I could start working on an initial
version of some of these diagrams if you are interested in the idea.

regards,
- --
 Rafael Martinez, <r.m.guerrero@usit.uio.no>
 Center for Information Technology Services
 University of Oslo, Norway

 PGP Public Key: http://folk.uio.no/rafael/
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAku55ocACgkQBhuKQurGihRbJQCfVA9SYVWkyfudFg7XPDlLXYeV
tKAAmgMjg1tfU63sf0RTMRoFTtfsn/Pj
=2+9o
-----END PGP SIGNATURE-----

pgsql-docs by date:

Previous
From: Devrim GÜNDÜZ
Date:
Subject: Re: PDF build issue with 9.0 Alpha5
Next
From: Oleg Bartunov
Date:
Subject: Re: Documentation and explanatory diagrams