Understanding documentation fixes

[Emma Jane Hogbin]

Neil Robinson wrote:
> The first two proposals are probably too much work, by your own admission.
> I think the 3rd proposal should definitely be implemented and the 4th
> proposal should be implemented if possible.
>>       * Only update the website. This could again be done on a schedule,
>>         so we can fix several bugs at once. However, on noticing
>>         differences between the online and offline help, users might not
>>         know which one to trust. Advantages: Updates available to many
>>         users. Disadvantages: installed help not updated, differences
>>         between online and offline help.
> The disadvantage here can be worked around by placing a clear notice on
> the offline help that the latest version of the help files are available
> on the net.
> Similarly, such a notice should be posted on the online help to indicate
> that the offline help may possibly be out of date.

+1 for keeping the Web site updated.

In the Linux Documentation Project we asked authors to track the version
of their document. The version number was part of the distributed
document. This allowed readers to easily tell what version they were
reading (and to compare versions if they found multiple copies).


regards,
emma

-- 
Emma Jane Hogbin, B.Sc.
Founder, xtrinsic
phone: (519) 371-2665
web: www.xtrinsic.com