PGCon2019 - 3.4
PGCon 2019
The PostgreSQL Conference
| Speakers | |
|---|---|
|
Corey Huinker |
| Schedule | |
|---|---|
| Day | Talks - Day 1 - 2019-05-30 |
| Room | DMS 1160 |
| Start time | 15:00 |
| Duration | 00:45 |
| Info | |
| ID | 1366 |
| Track | Community |
| Language used for presentation | English |
| Feedback | |
|---|---|
|
Did you attend this event? Give Feedback |
In aid of RTFM
Improving our documentation
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.