[Bf-docboard] Serious Issue: Versioning - Proposal

[Tobias Regenbrecht]

Am Samstag, 12. November 2005 10:42 schrieb Tom M:
> The current state of the manual isn't valid to any version - it is a
> mix between 2.35, 2.36, 2.37a and 2.40 so until things are updated
> across the board to 2.40 it doesn't really make sense to do what you
> propose.  However even after we are caught up to 2.40 your idea adds a
> lot of overhead for, in my view, limited gain.  If you want different
> manuals for different versions, then once it is agreed to document a
> new upcoming release - a full copy and automatic renaming could be
> done and only bugfixes should be made to the original version.
>
> Also the images for pretty much every section will need to be redone
> after the UI update is committed (you can see Tuhopuu for most of the
> changes but Matt I believe will be adding a few other improvements as
> well.)

1) I assume that we will never (or only at very rare occasions) get a state 
where the manual is valid in all parts for the current version of blender. 
And I don't think that this is necessary. Some sections in the heterogenous 
version right now are working well, though they don't cover version 2.37a 
explicitly.
2) It may make sense to update the documentation on mediawiki to version 2.40 
and make a version freeze at that point. But there will be another version 
out before the current manual is updated completely. So it may be the case 
that one should have to document an outdated version of blender, just to 
finish the manual ...
3) You will break expecially the spanish translation of the current manual 
(the others translation are finished only in small parts). In fact, it may be 
practically impossible to keep a transplated version up to date - and what is 
worse, one may not refer to an image in a translated version. The image may 
change at any time so you can't be sure what's on it.

With kind regards
-- 
T. Regenbrecht