Hello. Silvia and me have created a DRAFT for XWiki.org Documentation Standard found at : http://dev.xwiki.org/xwiki/bin/view/Drafts/XWikiOrgDocumentationStandard
In order to move towards the final version, we need your input on 2 issues. - For which project version we create & maintain documentation - Which skins we are going to support in the documentation (latest/all) Although, these issues were discussed in December 2009, no final result came out of them. http://markmail.org/message/ou7hgdiiwgayghku#query:+page:1+mid:ou7hgdiiwgayghku+state:results 1. the project version (XE version for ex) for which the documentation is created/updated/maintained. We have several choices: a) We make the documentation only for the latest version. b) We make the documentation only for the latest version, and we export the pages at release time and make it available as a zipped HTML export so that people using the older version can refer to them. c) We make the doc work the last 2 releases. That would be 2.3 and 2.4. Note: If option b) is chosen then we need to add a step to the release process. (export for every release) 2. The skin used for documenting steps. This also includes the screenshots. Again we have several choices: a) Document only for the latest default skin. b) Document for all supported skins. Right now that would be Toucan + Colibri (not sure about Albatross, I don't think we've officially said it wasn't supported). Note: If option b) is chosen, this would mean 2 screenshots for the same feature (one for each skin) The vote content was mostly taken from the markmail link above. If you have any other suggestions regarding this draft, please reply and state your opinion. We need as much feedback as possible in order to create a solid documentation standard. _______________________________________________ users mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/users
