Chris Gahan wrote:
Wow, it's really awesome to see excitement about Webware again. This is inspiring! :)

One thing I'd like to help improve is the documentation -- specifically, the documentation that introduces people to Webware.

There's a lot of great info on the website, the wiki, and in the source's pydoc strings, but it's hard to see the big picture at first because the amount of information is overwhelming. Being able to find what you're looking for is harder than it should be. I think it just needs a bit of the old top-down-hierarchical-organization-and-refactoring. :)

When I was starting out, I found it kinda confusing that the "On-line Docs" were API references, and that most of the "Papers" covered a lot of the same thing, but with slight differences here and there (I think they're great as introductions, but they all be kneaded together into one really good document, placed on a page called "Turotial" :).

It's a shame that the introduction to Webware can be confusing since Webware is such a clean and simple framework, once you understand it.

I'd like to help overhaul this whole thing, but you know... NO TIME RIGHT NOW(tm). Damn you, world-that-has-too-much-stuff-to-do-in-it!!!

Anyhow, does anyone else here share my love of helping people understand things and simplifying? The Webware community will become kickass if more people realize how cool it is.

Definitely better documentation is always good -- there's always more to be done. If we put this stuff in the Wiki, people can improve the documentation with whatever pace they can manage -- the only problem might be reorganization, which (outside of reorganizing a single document) would probably be a bit of a pain in the Wiki.


I'm planning on adding a comment feature to the wiki, which is basically a bottom-post with signature, which might encourage feedback on documentation; comments can serve as good source material for later reorganizations.

Other ideas about the documentation are also welcome. Certainly we can open up space in Subversion for people to collaborate as well, if that seems like a better environment. (And *maybe* we could put the Wiki into Subversion... that would be clever; maybe not that hard)

Ian


------------------------------------------------------- This SF.Net email is sponsored by: IBM Linux Tutorials Free Linux tutorial presented by Daniel Robbins, President and CEO of GenToo technologies. Learn everything from fundamentals to system administration.http://ads.osdn.com/?ad_id=1470&alloc_id=3638&op=click _______________________________________________ Webware-discuss mailing list [EMAIL PROTECTED] https://lists.sourceforge.net/lists/listinfo/webware-discuss

Reply via email to