subsurface manual

Dirk Hohndel dirk at hohndel.org
Sat Nov 16 11:14:28 UTC 2013


On Sat, 2013-11-16 at 21:02 +0200, Willem Ferguson wrote:
> At this link is a very first attempt to initiate a manual for the Qt 
> version. Consider this as extremely preliminary. This text is focused on 
> the manual dive entry part only. However, in order to write about manual 
> data entry, it was necessary to do some higher level descriptions 
> beforehand.
> 
> https://www.dropbox.com/sh/fzf4nacfb6lwe5x/j_EfpLuyox
> 
> There are several issues about which I would like comment:
> 
> 1) The basic way of dealing with graphics in such a manual.

Not sure what you are asking - can you elaborate?

> 2) The numbering system for different sections. Here I followed the 
> conventions of the 3.1 user manual.

The numbering isn't set in stone. The 3.1 manual grew over time. I'm not
sure the existing structure is the be-all-end-all.

> 3) The efficiency of the text to communicate with the reader.

That is critical. Reading your draft sounded very good to me. But I am
by no means an accomplished tech writer.

> 4) Critical content-wise omissions or misrepresentations pertaining to 
> the manual entry of dive information.

I'll ask others to chime in...

ideally I'd love to to get what you have as commits (including the
images) so we can maintain this in git and it's easier for others to
contribute.

Thank you for an EXCELLENT start towards a 4.0 manual.

Much appreciated

/D



More information about the subsurface mailing list