http://nagoya.apache.org/wiki/apachewiki.cgi?StrutsProjectPages%20
A wiki is great for making comments, but it's not such a good vehicle for transporting the documentation and maintaining it over time. A good project might be to setup companion wiki pages for each page in the documentation. The website page could then link to its wiki page (and vice versa). If anyone wants to do that, just go ahead, and then just send us the documentation patches with the links through Bugzilla.
Another good idea is to post copies of the "best-of" threads from the email list to the wiki, for future reference and comment. See the "NewFaqs" topic for an example. James has another example on his page, under MailDocumentation.
One suggestion has been to prefix all the Struts pages with struts-, just as way to keep them grouped together.
Overall, with the documentation, I'd like to streamline the User Guide
http://jakarta.apache.org/struts/userGuide/index.html
by making more of the sections standalone "How Tos".
http://jakarta.apache.org/struts/faqs/index.html
Personally, I'd like the user-guide to be a relatively code-free big-picture overview (as it once was), and put the coding examples in the How Tos.
Of course, each How To could also have a corresponding wiki page with reader comments.
Then at some point, we could patch the better bits from the wiki's back to the conventional documentation.
-Ted.
Adam Hardy wrote:
This is something I'm also interested in. I believe self-improving documentation can help greatly.
I don't know who put the wiki up there or what they intended to use it for, or even if there is a limit on the amount of info that the wiki will take.
I'll try to look at it at some point soon since I would like to launch my own wiki to do a brain dump into, since too much of what I know on java, linux etc tends to leak away without trace.
However I ain't no documentation pro. I just copy documentation frameworks that I find useful. The mysql "complete searchable" docs with user comments is great.
Perhaps when great messages get posted here, once a struts documentation basis exists, posters could get into the habit of writing the info into the wiki as well.
David (Graham) - you're mentioned as documentation submitter - perhaps you could give us your opinion on this.
Adam
On 08/14/2003 06:06 PM K.C. Baltz wrote:
Yes, but it doesn't have the Struts documention in it, where it could be annotated via the Wiki mechnisms. I think this is an excellent idea. I'm not very familiar with Wiki, so I don't know how hard it would be to copy all that documentation, but I think it would be worth it.
K.C.
Adam Hardy wrote:
A struts-wiki already exists! Check the resources page of the struts website for the link.
Sydenham, Nick wrote:
As has been pointed out by several people the Struts documentation is rather
poor in terms of how to apply it. The books on the subject tend to be very
specific and don't really address real-world issues.
My suggestion is that the existing Stuts documentation is converted into a
wiki that everyone can use and update as they find answers. Example:
http://twiki.org/
Is this a good idea?
********************************************************************************************
" This message contains information that may be privileged or confidential and is the property of the Cap Gemini Ernst & Young Group. It is intended only for the person to whom it is addressed. If you are not the intended recipient, you are not authorized to read, print, retain, copy, disseminate, distribute, or use this message or any part thereof. If you receive this message in error, please notify the sender immediately and delete all copies of this message ".
********************************************************************************************
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
-- Ted Husted, Junit in Action - <http://www.manning.com/massol/>, Struts in Action - <http://husted.com/struts/book.html>, JSP Site Design - <http://www.amazon.com/exec/obidos/ISBN=1861005512>.
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
