Re: User documentation vs Official Docs

From: "Joshua D(dot) Drake" <jd(at)commandprompt(dot)com>
To: Tim Cross <theophilusx(at)gmail(dot)com>
Cc: "Psql_General (E-mail)" <pgsql-general(at)postgresql(dot)org>
Subject: Re: User documentation vs Official Docs
Date: 2018-07-16 22:18:43
Message-ID: 93682ae8-9912-cfc2-5c53-ddcea4db9c05@commandprompt.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-general

On 07/16/2018 03:07 PM, Tim Cross wrote:
>
> I think encouraging user developed docs is a great idea.
>
> However, I'm not sure how your proposal really addresses the issue. How
> would your proposal deal with the "but let's be honest, writing a
> blog/article/howto in a wiki is a pain in the butt" issue? Writing
> decent documentation or clear examples is hard and the only thing worse
> than no documentation is misleading or confusing documentation.

Well I threw all this out there to start a discussion on how best this
could be done. What *I* would do is either create a series of templates
to be followed that we would push to HTML and PDF. That could be done
with a form and TinyMCE or we could use LibreOffice/Office templates.
However, I don't know that the community would buy into the office
template idea (thus seeking feedback).
> My only real concern would be to further fracture the PG user base. If
> there are barriers preventing users from adding documentation to the
> existing documents or wiki, perhaps it would be better to try and
> address those first?

First, my assumption is that this project would be done within the .Org
infrastructure and if the community thinks that we should just use
DocBook that is certainly an option (although adhering to something like
Docbook Simple may be best).

Thanks,

JD

>
> Tim
>

--
Command Prompt, Inc. || http://the.postgres.company/ || @cmdpromptinc
*** A fault and talent of mine is to tell it exactly how it is. ***
PostgreSQL centered full stack support, consulting and development.
Advocate: @amplifypostgres || Learn: https://postgresconf.org
***** Unless otherwise stated, opinions are my own. *****

In response to

Responses

Browse pgsql-general by date

  From Date Subject
Next Message Joshua D. Drake 2018-07-16 22:19:16 Re: User documentation vs Official Docs
Previous Message Adrien Nayrat 2018-07-16 22:16:13 Re: Query to monitor index bloat