Re: Suggestion to improve PostgreSQL documentation clarity - Mailing list pgsql-docs

From Laurenz Albe
Subject Re: Suggestion to improve PostgreSQL documentation clarity
Date
Msg-id 1a8665730d39a0e44516bb5d94230a522324db1b.camel@cybertec.at
Whole thread
In response to Suggestion to improve PostgreSQL documentation clarity  (PG Doc comments form <noreply@postgresql.org>)
List pgsql-docs
On Sun, 2026-07-12 at 16:09 +0000, PG Doc comments form wrote:
> I am a PostgreSQL learner and community member. While studying PostgreSQL
> documentation and working on database projects, I found that some sections
> could benefit from additional beginner-friendly explanations and practical
> examples.
>
> I suggest adding more step-by-step examples for new users, especially around
> database setup, connection configuration, user privileges, security
> settings, and common migration workflows.

I am not certain if the documentation is the correct place for that.
There is a difference between documentation and a tutorial, and mixing
them won't be a service to anybody.

Now the documentation already contains examples, and those are clearly
fine (and more of them might be appropriate occasionally).
But step-by-step examples for new learners wouldn't be good.

However, the documentation contains a small tutorial, and there your
proposed additions would be fine.

Yours,
Laurenz Albe



pgsql-docs by date:

Previous
From: Laurenz Albe
Date:
Subject: Re: 18.4. Managing Kernel Resources
Next
From: surya poondla
Date:
Subject: Re: Clarify log_parameter_max_length docs regarding log_min_duration_statement vs log_duration