We're sorry but this page doesn't work properly without JavaScript enabled. Please enable it to continue.
Feedback

In aid of RTFM

Formal Metadata

Title
In aid of RTFM
Subtitle
Improving our documentation
Title of Series
Number of Parts
35
Author
License
CC Attribution 3.0 Unported:
You are free to use, adapt and copy, distribute and transmit the work or content in adapted or unchanged form for any legal purpose as long as the work is attributed to the author in the manner specified by the author or licensor.
Identifiers
Publisher
Release Date
Language

Content Metadata

Subject Area
Genre
Abstract
A discussion of ways to improve the documentation ecosystem for PostgreSQL inside core, other sources and help in citing those sources in outside forums. The documentation for PostgreSQL is quite extensive, but that can work against us when attempting to cite a specific feature or function. We are left with telling information-seekers here's a link to a very long page, look for the $SEARCH_TERM in that page. Some users seem to learn best when first given a concrete example of the usage of a command or feature, and only then will the abstract documentation make sense. This talk proposes a number of incremental changes that could improve the usability and durability of our documentation in both core and the ancillary wikis. Such as examples with date/version context, flagging new features, and persistent reference anchors. It will also propose some standards for citation of sources when making references to them in outside forums like StackExchange.