New user guide help file format

[bradr]

I'm considering (actually I think I've decided) that the help file format for Cantabile 2.0 will be changed from traditional compiled HTML (chm) to a single PDF file.

There's a couple of reasons for this:

* I've been asked quite a few times for a single printable manual and a PDF covers that nicely.
* It's much easier for me to maintain and therefore more likely to stay up to date. Instead of lots of little files that all get compiled into one, I just work in Word and save it as a PDF.

The downsides are:

* The help will no longer be context sensitive. ie: launching help from a dialog will just show the PDF rather than the help for that dialog. I might be able to fix this but the solution is painful (does anyone know how to get named destinations out of Word 2007 and into a PDF while still maintaining bookmarks and links?)
* It will require a PDF reader is installed in order to view the help - not a big problem imo.

On this subject is there anything that you feel needs to be better explained than what's currently in the help (aside from things that are new to 2.0 that I haven't documented at all)?

I'm aiming to have this new user guide ready for the build after next. Thoughts?

Brad

[TiUser]

As long as your new documentation still covers so meticulously any detail I don't care about the format...

[Debby747]

I've read that writing a good documentation enables a programmer to also write a good software.

I welcome the new printable PDF manual!
I need it. I'll read it.

I know it is a lot of tedious work to write a manual when you're actually after progression in Cantabile itself- but it is a vital part and I am very glad you are back on it.

Greetings,
D.

[bradr]

I don't care about the format..

Good. I've decided definitely, PDF it is.

I've read that writing a good documentation enables a programmer to also write a good software.

Probably, so I guess I'm doing it a bit backwards.

...and I am very glad you are back on it.

I'm not so glad tedious, tedious, tedious. But it's got to be done so no use complaining.

Anyway, thanks for the feedback. I've still got a few sections left to write then I'll put it up somewhere for anyone who's interested.

[bradr]

First draft now available: http://www.kvraudio.com/forum/viewtopic.php?t=243051