[Lazarus] Building help files: the nitty-gritty

Mark Morgan Lloyd markMLl.lazarus at telemetry.co.uk
Wed Jul 18 21:15:32 CEST 2012


Graeme Geldenhuys wrote:

>> At work I use Delphi, but I don't ship help with those either.  (though I
>> have in previous jobs).  We ship latex generated manuals in PDF format for
> 
> You guys have it way to easy! :)  All our apps must ship with help
> files, and we have a separate installation PDF. Our end-users are not
> the most computer literate, but they know everything about Maths and
> Science.

This is a bit like the argument about whether code should be commented 
or properly-written. I normally argue for copious comments in source, 
but at the same time I think I favour properly-designed forms and 
components which don't need on-screen help.

Having a decent manual, possibly with weak linkage to the app so that it 
opens on the right page (something that PDF is bad at) is a different issue.

-- 
Mark Morgan Lloyd
markMLl .AT. telemetry.co .DOT. uk

[Opinions above are the author's, not those of his employers or colleagues]




More information about the Lazarus mailing list