RE: [xwiki-dev] This month is DOC month

Cody, It's great to see some focus on XWiki documentation. Thanks for taking the lead on this. Since XWiki is constantly evolving, one of the challenges of documenting it is the "moving target" phenomenon. Say you document the XWiki permissions UI. Then a new version is released, and the permissions UI changes. For a time (perhaps a very long time), the documentation is out of sync with the current released version. This will cause end-user confusion and frustration, and it's an example of how out-of-date documentation can be worse than no documentation at all. Other examples include users running old versions of XWiki, looking at a documentation page that describes how a particular feature works in the current released version, and experiencing confusion. To help address these challenges, I suggest affixing a message at the top of each documentation page, like this: For XWiki version: 0.9.840+ As new versions of XWiki are released, the documentation team can review each documentation page and determine whether the material is out of date. If the new version differs substantially in its behavior, the message could be changed to: For XWiki version: 0.9.840 - 0.9.970 where 0.9.970 is the last version that the page accurately documents. This will help readers to know whether the page accurately documents the version of XWiki they're using. Eventually, the page will be revised to reflect the new functionality, but users running old versions of the XWiki software still need a way to view the documentation for their version. To deal with this, the documentation could provide a link to to the older version of the page. Something like this: For XWiki version: 0.9.975 See also: <link>XWiki 0.9.840 - 0.9.970</link> Thoughts? Stephen