[clug] Man pages.

Bob Edwards Robert.Edwards at anu.edu.au
Mon Jul 27 01:09:06 UTC 2015

On 27/07/15 10:30, Ivan Lazar Miljenovic wrote:
> On 27 July 2015 at 08:48, Bob Edwards <Robert.Edwards at anu.edu.au> wrote:
>> On 24/07/15 19:37, Bryan Kilgallin wrote:
>>> Andrew wrote:
>>>> These toolkits are now all developed on github and it begs
>>>> the question if I should use something else to write the documentation
>>>> (markdown?) and then create the man page from it via some tool.
>>> Please test text for readability, using software such as the following
>>> site.
>>> http://www.online-utility.org/english/readability_test_and_improve.jsp
>> I tested that paragraph at that website and it says it should be
>> comprehensible ("understood") by someone with between 7.75 and 9.71
>> years of formal education (depending upon which "index" you subscribe
>> to). So, someone with a (basic) Yr 10 certificate.
>> What level of education do _you_ think posts to this list should be
>> striving for?
>> I really can't see anyone methodically (sorry...) testing each post
>> to this (or any other) list for readability at such a site before
>> hitting the "Send" button...
> I thought Bryan was referring to the text of the man pages, rather
> than posts to this list.

Oh, my bad. Sorry Bryan. It is a good point you make that the text of
the man page should be checked. Sorry for the mis-read.

Bob Edwards.

More information about the linux mailing list