Hi,<br><br>Here's how it was with CiviCRM. This might be tangential since our decisions were pragmatic rather than technical but maybe useful background...<br><br>We wrote the first manual in a sprint when version 2 was out. About a year later when version 3 was out, we had another sprint.<br>
<br>Our motivation in the second sprint wasn't only to cover new functionality in version 3 - in fact there were some big holes left over from the first manual. And we wanted to improve already existing chapters, etc.<br>
<br>So we branched the book, worked on the second edition and didn't back port any of our improvements back to the first edition. We've now hidden the first edition and I personally would recommend that anyone (regardless of the version they are using) should use our second edition.<br>
<br>In the end, both books are general CiviCRM books that happen to be about a specific version because they were written when that version was the latest version.<br><br>It would be v. hard for the CiviCRM documentation community (which is quite small) to keep to date two differerent versions of the book and actually, we don't see it as that important. But that is down in part to the style of the book (the content of which is not that closely to a version of the software), the nature of CiviCRM as a software project (quickly evolving) and the CiviCRM community (which isn't massive).<br>
<br>Anyway, this doesn't really answer your question but that is because (like i said above) for pragmatic reasons, we didn't need to. Maybe that is helpful for you :)<br><br>Michael<br><br><br><br><br><div class="gmail_quote">
On Mon, Sep 13, 2010 at 5:03 PM, Mark <span dir="ltr"><<a href="mailto:mark.brennan@gmx.com">mark.brennan@gmx.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
<div text="#000000" bgcolor="#ffffff">
<font face="Helvetica, Arial, sans-serif">Hello Everyone - <br>
<br>
How do we handle different software versions when writing Floss
manuals? By versions I mean by platform and by numbered release. <br>
<br>
I can think of a few ways to do this:<br>
</font>
<ol>
<li><font face="Helvetica, Arial, sans-serif">Create a new manual for
each version. For example, </font>Firefox 3.x and Firefox 4.x would
have separate manuals. <br>
</li>
<li>Incorporate all versions into a single manual by adding a chapter
that describes the differences.</li>
<li>Incorporate all versions into a single manual by describing the
differences, where they exist, for each feature.</li>
</ol>
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. <br>
For suggestion 2, we would have chapters that might never be read. <br>
Suggestion 3 might work the best. If you are describing a feature, you
could describe how it works under Windows, Mac, and Linux. <br>
<br>
Any thoughts?<br>
<br>
Thanks,<br>
<br>
Mark<br>
</div>
<br>_______________________________________________<br>
Discuss mailing list<br>
<a href="mailto:Discuss@lists.flossmanuals.net">Discuss@lists.flossmanuals.net</a><br>
<a href="http://lists.flossmanuals.net/listinfo.cgi/discuss-flossmanuals.net" target="_blank">http://lists.flossmanuals.net/listinfo.cgi/discuss-flossmanuals.net</a><br>
<br></blockquote></div><br><br clear="all"><br>-- <br><font style="color: rgb(102, 102, 102);" size="1"><span style="color: rgb(51, 51, 51);"></span><span style="color: rgb(51, 51, 51);">Michael McAndrew</span><br style="color: rgb(51, 51, 51);">
<span style="color: rgb(51, 51, 51);">07817 802299 (mobile)</span><br style="color: rgb(51, 51, 51);"><br style="color: rgb(51, 51, 51);"><span style="color: rgb(51, 51, 51);">Third Sector Design Ltd.</span><br style="color: rgb(51, 51, 51);">
<a href="http://thirdsectordesign.org" target="_blank"><span style="color: rgb(51, 51, 51);">http://thirdsectordesign.org</span></a><br style="color: rgb(51, 51, 51);"><br style="color: rgb(51, 51, 51);"><span style="color: rgb(51, 51, 51);">For support, email <a href="mailto:support@thirdsectordesign.org" target="_blank">support@thirdsectordesign.org</a></span></font><br>