Including an image in a wiki is as simple as specifying its URL. It is way easier to create a diagram and put it on our wiki than to create a diagram and put it on our website. Alternatively, you can upload an image and attach it to the wiki page by typing 'attachment:someimage.gif' in the page 'source'. The same goes for other kinds of content.
As an example of a project that has successfully used a wiki to improve its documentation, take a look at cocoon. Their docs used to be worse than avalon's, which changed quite quickly after setting up their wiki:
http://wiki.cocoondev.org/Wiki.jsp
Another famous example of a project that has "Edit this page" functionality for its entire website is mozilla:
http://doctor.mozilla.org/
Pawel X Karendys wrote:
I think you need to be careful placing too much weight on the Wiki. It forces one to do more-or-less text-based documentation and, as you all know, Avalon's documentation can not be called "diagram-rich". ;) To me, Wiki should be treated only as a pre-documenation stage/container for hot thoughts and ideas before the real thing is going to be produced.
to me, wikis are the content management system idea "done right". Easy web-based editing, seperation of content from presentation, and evolvable in every possible direction.
For example, have you had experience actually using a wiki internal to your organisation? It has helped one or two projects I was involved with tremendously.
If apache is a company, and avalon a division, the wiki is our open collaboration space (CVS, on the other hand, is closed).
People should be able to read/download a comprehensive documentation that explains concepts using diagrams supported by reasonable good explanation.
that is the goal. Totally agreed. Additional goals include up-to-date documentation, well-structructured documentation, objective documentation, etc etc. But I really can't see why an "edit this page" link gets in the way of that :-D
-- cheers,
- Leo Simons
----------------------------------------------------------------------- Weblog -- http://leosimons.com/ IoC Component Glue -- http://jicarilla.org/ Articles & Opinions -- http://articles.leosimons.com/ ----------------------------------------------------------------------- "We started off trying to set up a small anarchist community, but people wouldn't obey the rules." -- Alan Bennett
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
