Fwd: Re: [Zope] beginner
Hi! Sorry - I just noticed that I've sent this mail to Chris directly instead of adressing it to the list... Here we go again... ---------- Forwarded Message ---------- Subject: Re: [Zope] beginner Date: Mon, 2 Jul 2001 11:08:11 +0200 From: Gernot Hillier <gernot@hillier.de> To: "Chris McDonough" <chrism@digicool.com> Hi!
What, specifically, about the documentation is poor? How can we improve it?
I'm a Zope newbie, too, and I had similar problems with the documentation. So may I make some suggestions for the improvement of your help system: - It would be great to group the HowTos in an intuitive way. It's not very nice to go to "New-User-HowTos" and have to search through 121 documents which are not related to each other. - It would be a great relief if you could search through a special category only, for example I want to search only the SiteDeveloper-HowTo's for some keywords - if there is already some feature like this available - I wasn't able to find it, sorry :-(( - It would be very helpful to make the output of the search function more informative. For example, I searched some information about using XML in Zope. What's the way to go? If I search for "XML" I get 457 items and can only see some names which don't tell me something meaningful. How about using some kind of summary for each HowTo? Again, here it would be very helpful to be able to search through some special categories only... I think the problem isn't the lack of documentation for Zope, but the lack of good ways to find it. But this should not mean you do bad work - I'm very excited about the really interesting features Zope offers me and the Zope Book is really very nice!! It's very hard to understand most of the Zope internals for me - in spite of me being well used to object oriented programming. And it's IMHO not possible to do more than the most simple things without a understanding how Zope works - for example I had big problems in creating the most simple pyhton scripts because I can't use my standard_html_header in them, I had some expressions working inline a dtml-var but not in a python script, and so on... All pyhton expressions I used to write were subject to a extensive try and error testing... Unfortunately I had no time to read the ZDB yet, perhaps it will help me to understand more... But I'm sure all these things will get better and Zope will be a real alternative to Apache & Co. sooner or later ;-)) -- Bye, Gernot
I think the problem isn't the lack of documentation for Zope, but the lack of good ways to find it.
Don't say your a beginner. This is what experienced users say. Experts are more familiar with www.zope.org and the various mailing list archinves. I agree that the looking-trivial-little-search-feature on zope.org really makes a difference for the future of Zope. The XML example was good. I've also suffered from that. Responsible; please don't say that you can do this and that with the advanced search. People don't want to do advanced searches since google was invented. No matter how smart and educated Zope software engineers and web programmers are, they are still very lazy and wants to be treated like babies. Peter
Hi Peter, hi * ! Am Montag, 2. Juli 2001 14:54 schrieben Sie:
Responsible; please don't say that you can do this and that with the advanced search. People don't want to do advanced searches since google was invented. No matter how smart and educated Zope software engineers and web programmers are, they are still very lazy and wants to be treated like babies.
Here I don't agree. It would be OK for me to use the advanced search if I only want to find documents in a special area, for example in the "Site Developer-HowTos". But this isn't possible with the advanced search either - or I was to silly to find it... -- Bye, Gernot
Am Montag, 2. Juli 2001 14:54 schrieben Sie:
Responsible; please don't say that you can do this and that with the advanced search. People don't want to do advanced searches since google was invented. No matter how smart and educated Zope software engineers and web programmers are, they are still very lazy and wants to be treated like babies.
Here I don't agree. It would be OK for me to use the advanced search if I only want to find documents in a special area, for example in the "Site Developer-HowTos". But this isn't possible with the advanced search either - or I was to silly to find it...
"it would be OK" Just like saying that "boo.com could be a success" ... "...if people took the time to enjoy technical problems and enjoy not finding content". No matter what is sensible, people are going to dismiss it if it ain't easily usable. Advanced searches are likely to fail because it requires the visitor to make choices and descisions. Honestly: I use the advanced search on zope.org and I think it is very usable. Good work! Bad example is my own site: http://www.peterbe.com/web/search (I keep it for the moment, it's done by Atomz) The search algorithm is also part of the usability issue here. Wikis should get second place in the search results, and when you click on a match, you should see your word highlighted like it happens on the zope mailinglist archive at NIP (http://zope.nipltd.com/public/lists/zope-archive.nsf/$$Search?OpenForm) Perhaps even incorporate some of that google magic? Making some pages more likely to match because other pages link to it (i.e. like it). Am I asking too much? (no) Peter
I'm a Zope newbie, too, and I had similar problems with the documentation.
So may I make some suggestions for the improvement of your help system:
- It would be great to group the HowTos in an intuitive way. It's not very nice to go to "New-User-HowTos" and have to search through 121 documents which are not related to each other.
Sure... this makes sense. I don't look much at the HowTos anymore. But you're right. :-( There was some community-led work done long ago on this. I guess it didn't do much.
- It would be a great relief if you could search through a special category only, for example I want to search only the SiteDeveloper-HowTo's for some keywords - if there is already some feature like this available - I wasn't able to find it, sorry :-((
No... I don't think there is.
- It would be very helpful to make the output of the search function more informative. For example, I searched some information about using XML in Zope. What's the way to go? If I search for "XML" I get 457 items and can only see some names which don't tell me something meaningful. How about using some kind of summary for each HowTo? Again, here it would be very helpful to be able to search through some special categories only...
Uh huh.
I think the problem isn't the lack of documentation for Zope, but the lack of good ways to find it.
OK, so if I can summarize, you're asking for HowTos on Zope.org to be organized more effectively, and you're asking for a "narrow-by-search" feature on Zope.org. I'm cc'ing the Zope-web maillist on this so this can go in the feature-request pile.
But this should not mean you do bad work - I'm very excited about the really interesting features Zope offers me and the Zope Book is really very nice!!
It's very hard to understand most of the Zope internals for me - in spite of me being well used to object oriented programming.
And it's IMHO not possible to do more than the most simple things without a understanding how Zope works - for example I had big problems in creating the most simple pyhton scripts because I can't use my standard_html_header in them, I had some expressions working inline a dtml-var but not in a python script, and so on... All pyhton expressions I used to write were subject to a extensive try and error testing... Unfortunately I had no time to read the ZDB yet, perhaps it will help me to understand more...
Yes. I'd read the Zope Book first.
But I'm sure all these things will get better and Zope will be a real alternative to Apache & Co. sooner or later ;-))
Well, that's not what Zope is trying to be, although, if it was, it's already there... but I think we appreciate the sentiment. ;-) Thanks, -- Chris McDonough Digital Creations, Inc. Publishers of Zope http://www.zope.org """ Killing hundreds of birds with thousands of stones """
Hi! Am Montag, 2. Juli 2001 16:02 schrieben Sie:
But I'm sure all these things will get better and Zope will be a real alternative to Apache & Co. sooner or later ;-))
Well, that's not what Zope is trying to be, although, if it was, it's already there... but I think we appreciate the sentiment. ;-)
Hmm. For me personally, Zope is a replacement for Apache + Perl - did I make a mistake? ;-)) -- Bye, Gernot
Well, that's not what Zope is trying to be, although, if it was, it's already there... but I think we appreciate the sentiment. ;-)
Hmm. For me personally, Zope is a replacement for Apache + Perl - did I make a mistake? ;-))
No.. of course not. Sorry. Most of the "documentation problem" is actually a preception problem and an organization problem. Folks (like yourself) perceive Zope to be "just 'this'", where 'this' is a very specific thing. In your case, it's a replacement for Apache and perl. You likely expect to see things in the docs about how to run a CGI script, how to untaint form variables, and maybe how to hook Zope up to MySQL. However, you need to do none of these things to use Zope. Zope doesn't serve CGI, you don't need to untaint formvars, and you don't need to use a relational database to make a dynamic website using Zope. Zope's got its own webserver, its got its own object database. Compound this problem with sets of folks coming to Zope from Vignette StoryServer, from Mason, from OpenACS, and from a J2EE world. All of these folks have different expectations of what Zope really is, what it does, and how it should work. This multipurposing confuses the bejeezus out of people when they first come to Zope, because there's no way a single set of docs could possibly serve all of those audiences. We'd need to write maybe four or five different sets of documentation to service all of these audiences. We can't do this for financial reasons. But people flounder aimlessly due to the disconnect and get very upset. Zope is different than the combination of Perl and apache (or insert your favorite dynamic website software here), so much different that you need to look at the problem you're attempting to solve a little differently to apply Zope to it. You need to get a conceptual understanding of the object database and how methods are called on Zope objects and lots of other stuff. This is a liability sometimes when all you want to do is "get it working" and you have little Zope experience. But I don't know of a quick fix other than pointing folks at the appropriate docs when they ask. - C
This multipurposing confuses the bejeezus out of people when they first come to Zope, because there's no way a single set of docs could possibly serve all of those audiences. We'd need to write maybe four or five different sets of documentation to service all of these audiences. We can't do this for financial reasons.
What could be good however : have a "how to make the transition" guide for differents origins. Maybe ask some experienced zope users who were using different tools before the discovered zope. Having for example a simple app written in php and then with zope, idem for coldfusion and others... But imho if you take the time to read and understand the zope book you get all of this and a lot more. something different : I had to search the php.net site for a particular function, and I found what is so cool about this site : users can search any php function very easily, and most important : *visitors can add comments and examples* to the function explanation. This could be added to the zope docs imho. One folder per function, and let the users add their own comments (guestbook like). something more different : why not add a guestbook-like system to every page of zope.org? This way we could read the experience of other users about the current page. My $0.02 about a site which already rocks. Philippe
One problem with adding comments to the function documentation for Zope (vs PHP) is that the function call layer (API) in Zope is incredibly ugly compared to PHP. Think manage_whatever etc. -Magnus
Why is that a problem for adding comments? ----- Original Message ----- From: <magnus/Websys@websys.no> To: <philippe.jadin@123piano.com> Cc: <zope@zope.org> Sent: Tuesday, July 03, 2001 1:08 PM Subject: Re: Fwd: Re: [Zope] beginner
One problem with adding comments to the function documentation for Zope (vs PHP) is that the function call layer (API) in Zope is incredibly ugly compared to PHP. Think manage_whatever etc.
-Magnus
_______________________________________________ Zope maillist - Zope@zope.org http://lists.zope.org/mailman/listinfo/zope ** No cross posts or HTML encoding! ** (Related lists - http://lists.zope.org/mailman/listinfo/zope-announce http://lists.zope.org/mailman/listinfo/zope-dev )
This multipurposing confuses the bejeezus out of people when they first come to Zope, because there's no way a single set of docs could possibly serve all of those audiences. We'd need to write maybe four or five different sets of documentation to service all of these audiences. We can't do this for financial reasons.
What could be good however : have a "how to make the transition" guide for differents origins. Maybe ask some experienced zope users who were using different tools before the discovered zope. Having for example a simple app written in php and then with zope, idem for coldfusion and others... But imho if you take the time to read and understand the zope book you get all of this and a lot more.
Yes... unless you really want to do something very specific to a particular system... like.. use regexes in Perl. You'd need to search almost forever to figure out how to expose regex functionality in Zope without using an external method. There are lots of other examples like this. All we can do is rely on the community and the maillist here.
something different :
I had to search the php.net site for a particular function, and I found what is so cool about this site : users can search any php function very easily, and most important : *visitors can add comments and examples* to the function explanation.
This could be added to the zope docs imho. One folder per function, and let the users add their own comments (guestbook like).
How about http://serenade.4-am.com/ZopeBook? This Zope Book instance is going away, so don't get too carried away adding comments... but if you like it, *please* let the Zope docs folks know that you'd like to get the Zope Book annotation/bugtracking system out of the SourceForge tracker and into this system by emailing docs@digicool.com .
something more different :
why not add a guestbook-like system to every page of zope.org? This way we could read the experience of other users about the current page.
This is the purpose of the CMF Discussion system (an example of which the above is *not*). - C
participants (5)
-
Chris McDonough -
Gernot Hillier -
magnus/Websys@websys.no -
Peter Bengtsson -
Philippe Jadin