Re: Suggestion to improve PostgreSQL documentation clarity

From: Laurenz Albe <laurenz(dot)albe(at)cybertec(dot)at>
To: bilalabdulkadir286(at)gmail(dot)com, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Suggestion to improve PostgreSQL documentation clarity
Date: 2026-07-13 14:42:05
Message-ID: 1a8665730d39a0e44516bb5d94230a522324db1b.camel@cybertec.at
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: 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

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message surya poondla 2026-07-13 19:05:10 Re: Clarify log_parameter_max_length docs regarding log_min_duration_statement vs log_duration
Previous Message Laurenz Albe 2026-07-13 07:45:29 Re: 18.4. Managing Kernel Resources