Documentation : Let’s make it better, now, together! - Sarah Haïm-Lubczanski

Improve the PostgreSQL documentation by making it more user-friendly, adding visual aids, and increasing discoverability, with a focus on better navigation and content organization.

Key takeaways

Documentation should be a tool to help users learn and understand the software, not just a source of information.
The current PostgreSQL documentation is potentially overwhelming and may not be suitable for beginners.
There is a need for more visual aids, such as diagrams, in the documentation to help users understand the concepts.
The documentation is not very user-friendly and could be improved with better filtering and searching.
The contributor guide for PostgreSQL documentation is not easy to find and may be a barrier to contributing.
diagrams could be improved by making them more accessible and easily understandable.
the documentation needs to be more comprehensive and cover more topics.
there is a need for more tutorials and how-to guides in the documentation.
Using diagrams and glossaries can help clarify complex information and make documentation more engaging.
Many users prefer to read documentation in a non-linear fashion and would benefit from more discoverable content.
The documentation should be improved for better navigation and content organization.
The documentation should be more user-centric, taking into account the needs and preferences of the target audience.
The documentation should be updated more frequently to reflect changes in the software and to keep users up-to-date.
Contribute to improving the documentation and make it better for everyone.

Documentation : Let’s make it better, now, together! - Sarah Haïm-Lubczanski

More talks