From: Robin M. <rob...@gm...> - 2005-10-02 22:55:09
|
On 9/30/05, Ian Bicking <ia...@co...> wrote: > Alright, annoyed with it before, I've redone it again: > > http://sqlobject.org/ My feedback: I'd like to see a link to the main SQLObject documentation, and maybe the main sqlbuilder documentation, in the upper-right navigation bar. That bar is what the eyes go to naturally, and it should have the main docs first on its list. If I had been a newbie to SQLObject, trying to figure out how to use it, this is what my thought process would have been: "OK, let's check out sqlobject.org." *typety-type* *click* "Main page, right. Ah, there's the navigation bar. Let's try SQLObject." *c= lick* "Nope, that takes me right back to the index page. I guess I wanted Modules." *click* "All right, here we go. Whoa, there's a *lot* of modules here. I have no idea where to start. Maybe with the first one, the sqlobject module?" *click* "OK, API reference, but how the heck do I *use* this thing? Where's that Back button?" *click* "Hmm, more modules. Where's the Documentation link?" "Oh well, guess I'll have to use something else then." Now because I had actually seen the SQLObject documentation before and knew that it had to be there somewhere, I went back to the front page and found it lower down. But that website design is going to lose any newbie who looks at it. Besides adding a link to the "main" docs in the upper-right navbar, I'd also suggest adding a warning to the top of the "modules" page: "This is API reference documentation. If you're just getting started with SQLObject, this is not the page that will teach you to use it. That page is over here (link). This page is for after you've gotten your feet wet and want to look up the exact parameters for function XYZ." Taking off my "pretend newbie" hat and putting on my "my feet are wet" hat, though: thanks. I love the API reference documentation, especially the ellipsis link that points to the (syntax-highlighted) source. Very useful. But the current newbie-unfriendliness needs fixing, IMHO. -- Robin Munn Rob...@gm... GPG key 0xD6497014 |