Documentation and explanatory diagrams

From: Rafael Martinez <r(dot)m(dot)guerrero(at)usit(dot)uio(dot)no>
To: pgsql-docs(at)postgresql(dot)org
Subject: Documentation and explanatory diagrams
Date: 2010-04-05 13:33:19
Message-ID: 4BB9E69F.9080203@usit.uio.no
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: 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(dot)m(dot)guerrero(at)usit(dot)uio(dot)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-----

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Oleg Bartunov 2010-04-05 13:53:55 Re: Documentation and explanatory diagrams
Previous Message Devrim GÜNDÜZ 2010-04-05 12:05:38 Re: PDF build issue with 9.0 Alpha5