On Sun, 22 Jul 2012 18:37:53 +0000, Martin Gregorie wrote:

On Sun, 22 Jul 2012 08:31:01 +0000, Max Kellermann wrote:

wrote:
Facebook seems to be a good platform for a live manual

I don't think so - unless all of your users have a Facebook account.
Are you aware that you can't read any details without being logged in?

(I don't have a Facebook account, but anyway I'm not a WinPilot user,
this is just a generic expression of my opinion)

Seconded.

IMO the correct place for a manual is on a website which doesn't need
any special sign-ups to access, and the correct format for the manual is
standards-compliant HTML 5 or PDF. Making it available as a downloadable
ZIP archive is also a nice touch, especially if it takes the form of a
set of HTML pages plus linked images.

I should have added - "standards-compliant" means that HTML-tidy, a
freely available HTML validation tool that is supported by W3C, reads it
without producing any error or warning messages.

Note that quite a few HTML editors and word processors which claim to
produce valid HTML don't in fact do any such thing. So, it would be a
good idea to check the first page or so of output from your chosen
writing tool with HTML-tidy before using it for the whole manual.

At a minimum you should look at the manual with several browsers before
publishing it. At a minimum you should try viewing it with FireFox, Opera
and the latest IE version since all will run in Windows machines. You
might also want to try it with Safari and Chrome since you can't dictate
your audience's choice of web browser.


--
martin@ | Martin Gregorie
gregorie. | Essex, UK
org |