[FM Discuss] Software versions and user guides

[James Simmons]

Mark,

One way you could deal with this is to publish a PDF and an EPUB of
each version on the Internet Archive as you finish writing it.  Booki
or Twiki would only have the latest version of the book, about the
most current release of the software, but you could refer your readers
to IA for the older manuals.

James Simmons


On Mon, Sep 13, 2010 at 11:03 AM, Mark <mark.brennan at gmx.com> wrote:
> 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:
>
> Create a new manual for each version. For example, Firefox 3.x and Firefox
> 4.x would have separate manuals.
> Incorporate all versions into a single manual by adding a chapter that
> describes the differences.
> 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
>
> _______________________________________________
> Discuss mailing list
> Discuss at lists.flossmanuals.net
> http://lists.flossmanuals.net/listinfo.cgi/discuss-flossmanuals.net
>
>