Hy, Bertrand; yes, you are right: first determine the requirements, then start thinking about how to reach them ... One additional comment to your list:
> 4) SHOULD make these docs and their comments searchable, separately > from > the technical and/or unchecked existing docs to prevent beginners from > being overwhelmed with irrelevant search results. I would say, this is a MUST (giving one argument against separate wikis ;-) And one question: > 6) SHOULD be integrated with existing Cocoon community tools to avoid > fragmentation of skills and resources (for me it is actually a MUST > ;-) I'm just curious: What tools do you mean ? (maybe i should have a look into the cocoon documentation framework first?) regards, hussayn Bertrand Delacretaz wrote:
Cocoon "newbie docs" requirements:
1) GOAL: create a source of reliable information for Cocoon newbies, along the lines of "how to setup Cocoon in 15 minutes" and ""HOWTO setup your intranet with XML in 1 day"
2) MUST allow users to comment/improve these docs, in "wiki mode" to make it as easy as possible
3) MUST clearly identify these docs as being "for beginners" and "reviewed by an editor of the Cocoon team" to prevent beginners from getting lost in obsolete/unreliable docs
4) SHOULD make these docs and their comments searchable, separately from the technical and/or unchecked existing docs to prevent beginners from being overwhelmed with irrelevant search results.
5) MUST allow all wiki docs (these and existing ones) to be searchable simultaneously, to prevent users from having to search in X different places for info.
6) SHOULD be integrated with existing Cocoon community tools to avoid fragmentation of skills and resources (for me it is actually a MUST ;-)
What do you think?
-Bertrand
---------------------------------------------------------------------
Please check that your question has not already been answered in the
FAQ before posting. <http://xml.apache.org/cocoon/faq/index.html>
To unsubscribe, e-mail: <[EMAIL PROTECTED]>
For additional commands, e-mail: <[EMAIL PROTECTED]>
-- Dr. Hussayn Dabbous SAXESS Software Design GmbH Neuenhöfer Allee 125 50935 Köln Telefon: +49-221-56011-0 Fax: +49-221-56011-20 E-Mail: [EMAIL PROTECTED] --------------------------------------------------------------------- Please check that your question has not already been answered in the FAQ before posting. <http://xml.apache.org/cocoon/faq/index.html> To unsubscribe, e-mail: <[EMAIL PROTECTED]> For additional commands, e-mail: <[EMAIL PROTECTED]>
