7 Jun
2010
7 Jun
'10
2:01 p.m.
On Mon, Jun 7, 2010 at 11:55, Sorin Burjan <sorin.burjan(a)xwiki.com> wrote:
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:ou7hgdiiwgay…
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.
That would make sense only we we had a perfect documentation always
updated which is currently not the case. There is lot's of missing
stuff that someone will add at some point that will be true for old
versions too.
c) We make the doc work the last 2 releases. That
would be 2.3 and
2.4.
s/releases/branches/
d) What is done currently in many places is to indicate for a feature
the version where it has been introduced, it does not make sense
everywhere i guess but in some places it's very useful.
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.
+1 for a) i doubt we can do b). BTW I'm pretty sure we already talked
about that not so long ago.
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.
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
--
Thomas Mortagne