towards 4.9.4

Dirk Hohndel dirk at hohndel.org
Thu Apr 16 09:39:15 PDT 2020


On Thu, 2020-04-16 at 14:36 +0200, Willem Ferguson via subsurface
wrote:
> I'd like to see that the user manual is up to date for 4.9.4
> 
> Which are the obvious issues that you would like to see addressed?


This is a somewhat random laundry list - none of it is criticism of
where we are or how we got here, it's just my view of where I think I'd
like us to be. But let's start with the most obvious statement, first.
The user manual is very impressive and represents an amazing amount of
work. What I'm suggesting here really are minor corrections.

- I don't think the first segment really belongs in a user manual. I
think the part from "Subsurface offers many advantages..." to the end
of the bullet list should all be removed. This is a user manual, not an
ad.

- I want to remove the user survey as that hasn't really been useful as
it doesn't provide a mechanism to actually have a conversation with the
user. So we should drop that section as well.

- The first screen shot has an additional menu at the very top (File
Machine View Input...) that is not part of Subsurface. I find that
confusing.

- Section 5.1 we see several screen shots and a discussion of the "this
dive is being edited" warning. I believe (and Berthold, please confirm)
that this is now a thing of the past. If there still are actions that
trigger this warning, then I haven't come across of them in my use /
testing of the latest master.

- In 5.2.2 there is a Windows screenshot for the Bluetooth device
selection - that doesn't seem to match what I see on Windows. And
similarly, the text below that picture also describes something that I
believe no longer to be true. Windows now looks much more like the
other OSs.

- At the end of 5.2.5 the "This dive is being edited" warning is
discussed again. As above, I believe this is no longer accurate.

- The Information tab no longer looks like you depicted in the
screenshot in that section - the stylesheet that created this effect on
your system unfortunately caused a lot of issues on other systems as
recently discussed on the mailing list - so we removed it.

- At the very end of 5.2.5 there appears to be a markup issue as we are
seeing the underscore normally used to indicate italics in the line
starting with "The following three environmental parameters..."

- In section 5.5.1 you talk about 'create a Subsurface-mobile account';
I think we consistently call this a Subsurface Cloud Storage account
elsewhere. The screen shots are no longer accurate for the Subsurface-
mobile 3.0, but I don't think that's really an issue. But I wonder if
we shouldn't simply refer to the mobile manual here instead of
explaining this in the main user manual.

- section 6.6, the filter dialog has become even more complex. Both a
blessing and a curse, I guess.

- section 8 could mention the ability to export dive sites

- section 9.1, maybe mention that the email should be all lower case
and that the password should be letters, numbers, +-_

Looking through this I realize that we should have an option to open
the reset password website (just as we do on mobile)

- note: I haven't used the planner in years and haven't looked at this
section of the manual at all

section 18.1: let's drop the Zurich. I believe the download is broken
(at least I cannot download from my mostly dead Zurich anymore) and the
dive computer is not available anymore.




I know, this may look like a long list - but given the size of the user
manual, this is truly miniscule, just a couple of loose ends, really...

Thanks for all the amazing work that you do to make this user manual an
extremely useful resource for our users.

/D




More information about the subsurface mailing list