Subsurface-mobile V2 user manual

Rick Walsh rickmwalsh at gmail.com
Wed Oct 11 15:37:33 PDT 2017


On 12 October 2017 at 07:49, Willem Ferguson <
willemferguson at zoology.up.ac.za> wrote:

> On 11/10/2017 22:39, Dirk Hohndel wrote:
>
>> On Thu, Oct 12, 2017 at 07:06:53AM +1100, Rick Walsh wrote:
>>
>>> This is really important - the quality and readability of our user manual
>>>> makes a huge difference to our users. I really wish that more of us
>>>> would
>>>> spend the time to help out with the manual. This requires NO programing
>>>> skills at all - you don't need to send a diff, just comment on the text
>>>> and I'll turn this into commits for you. Your chance to become a
>>>> contributor to an open source project!
>>>>
>>> Thank you very much Willem for writing such a clear and thorough user
>>> manual. It looks great, and I only found one typo. 11.2. Dowload from DC.
>>>
>> Are you sending a patch?
>>
>> Being very very nitpicky, I noticed in section 14.1 that you spelt
>>> "behaviour" correctly, but earlier in you wrote "center" in American. I
>>> assume (but have no objection if we don't) we should be adopting American
>>> English throughout.
>>>
>> Correct, we agree on American English for all documentation. Again, a
>> patch would be most helpful.
>>
>> Sorry, I'm at work without my laptop with a build environment and will be
getting ready to go away for a few days (without a computer) this evening.
I could send a patch next week, but it might be easier if one of you make
those changes when you next edit the manual.

> Thanks
>>
>> /D
>>
>> Thanks for the kind words. I depart from the assumption that there is
> only one English language (my second language). Whatever else is used is
> just corruption of the English language. Since starting with the manuals I
> have attempted to be consistent because true English is spoken in many more
> countries than in the US and we want to avoid US-centric documentation. A
> significant part of the user base is in Europe. Therefore, for instance, no
> verbs with z's, etc. If I had a choice, I would correct the "center".
>
> I also favour English spelling.  You may be interested to learn that the
Oxford style guide mandate's -ize suffixes, and the Oxford Dictionary lists
-ise spelling as a variation.  I believe -ize is etymologically (and
phonetically - but that's rarely respected in English spelling) more
correct, derived from Greek, and the -ise spelling only became fashionable
around the 17th century in an attempt to look French (even though the words
are of Greek, not Latin origin).  For the record, the -ise spelling is far
more common here in Australia.

Rick
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.subsurface-divelog.org/pipermail/subsurface/attachments/20171012/6def49bc/attachment.html>


More information about the subsurface mailing list