The PostgreSQL Documentation and the Limitations of Community

This page summarizes the projects mentioned and recommended in the original post on news.ycombinator.com

WorkOS - The modern identity platform for B2B SaaS
The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
workos.com
featured
InfluxDB - Power Real-Time Data Analytics at Scale
Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
www.influxdata.com
featured
  • documentation-framework

    "The Grand Unified Theory of Documentation" (David Laing) - a popular and transformative documentation authoring framework

  • How-to and guides are an amazing way to do docs. I love the guides of Ruby on Rails. I rarely used the API documentation.

    There is a great article talking about the 4 different types of documentation named the “document system”.

    https://documentation.divio.com/

  • project

    project documentation, policies & meeting minutes (by openwebdocs)

  • Open Web Docs is a potential model to draw inspiration from regarding funding: https://openwebdocs.org

    Presumably, PostgreSQL has leaders who are responsible for steering the ship. If the project is going to succeed long-term, those leaders have to find ways to keep their contributors happy while also creating an organizational structure that leads to good docs.

    Sorry if any of my comments came off naive or obtuse when it comes to open source dynamics. But the reality is that you need good docs, and I'm just trying to give an honest assessment from my experience of the conditions that lead to good docs.

  • WorkOS

    The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

    WorkOS logo
  • diataxis-documentation-framework

    A systematic approach to creating better documentation.

  • Related: Diátaxis - A systematic framework for technical documentation authoring [1]

    "The Diátaxis framework aims to solve the problem of structure in technical documentation. It adopts a systematic approach to understanding the needs of documentation users in their cycle of interaction with a product.

    Diátaxis identifies four modes of documentation - tutorials, how-to guides, technical reference and explanation. It derives its structure from the relationship between them.(...)"

    [1] https://diataxis.fr/

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts