haleh mahbod wrote:
in the scenario where we would have 1.4, 1.4.1, 1.5 and 2.0 these
means 3 documentation wikis (1.4, 1.5 and 2.0) ?
Yes. Typically 1.x.x contains bug fixes and no major features.
Another option would be to have a 1.x and 2.x and each release ship a
snapshot of the wiki as it's documentation,
This is a problem that we are trying to solve. So, today if someone gets
1.1, documentation is at 1.4 level. It is confusing.
I am in favor of documentation wikis per release as long as it is done
at the point release or major release and not minor point release (e.g.
done at 1.3, 1.4, 1.5, 2.0, but not 1.4.1 and 1.4.2).
I also would prefer that the point release documentation become a
historical snapshot. I would hate to see dual maintenance on older
documentation snapshots.
One side comment. I cringe when I see TO-DO and TO-BE-DONE and
NOT-YET-IMPLEMENTED comments in documentation. These should be used
sparingly, perhaps as a reminder to the reader that a certain important
feature that might be expected is not available in Tuscany. They should
be there for the benefit of the reader, and not as a note to the next
editor to clean up. (Sorry, this sounds like a rant, but I'm not venting
at anyone in particular. I just want to add a helpful reminder.)
--
Thanks, Dan Becker
