[FM Discuss] Software versions and user guides

Mark mark.brennan at gmx.com
Mon Sep 13 09:03:55 PDT 2010


Hello Everyone -

How do we handle different software versions when writing Floss manuals? 
By versions I mean by platform and by numbered release.

I can think of a few ways to do this:

   1. Create a new manual for each version. For example, Firefox 3.x and
      Firefox 4.x would have separate manuals.
   2. Incorporate all versions into a single manual by adding a chapter
      that describes the differences.
   3. Incorporate all versions into a single manual by describing the
      differences, where they exist, for each feature.

Suggestion 1 would result in multiple versions of guides that may share 
a lot in common. This could cause extra maintenance work because a 
change to guide A might have to be repeated in guide B.
For suggestion 2, we would have chapters that might never be read.
Suggestion 3 might work the best. If you are describing a feature, you 
could describe how it works under Windows, Mac, and Linux.

Any thoughts?

Thanks,

Mark
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.flossmanuals.net/pipermail/discuss-flossmanuals.net/attachments/20100913/e9b70713/attachment.htm>


More information about the Discuss mailing list