Then a new user visits the front page, he is confronted with three equally likely links to click on:
* Learning wxPython
* Online wxDocs
* New wxPyDocs
This is not good.
-> Does "New wxPyDocs" mean that the other ones are old and outdated?
-> What is the difference between "Online wxDocs" and other docs? Aren't the others online too?
-> Which of these three links am I supposed to click on? I mean.. I do want to learn wxPython, but I do want online docs, and I do want the new ones. So which one is it?
These things need to be integrated and explained better. After clicking around I can see that the latter two should probably be called "API Reference". But there's still the issue of which one to pick.
SHHH....TTT I just realized that the "Online Docs" page is deceiving the user into thinking that these docs are wxPython docs! This is just a frame pointing to the wxWidgets docs!!!
If you click on "Oneline Docs" you get a page with a big huge title saying "wxPython". Then you see what looks like a *sub*title* about wxWidgets with a table of contents. This gives you entirely the wrong impression of what this page is about and how it relates to the other pages!!
Ok, this is what I recommend for links (in order):
-> Learn wxPython
-> wxPython API Reference
-> wxWidgets Documentation
Now the user knows what to expect from each link, and why there should be three links and not one.
Any chance that someone with admin rights can change the links like that?
Then a new user visits the front page, he is confronted with three equally
likely links to click on:
* Learning wxPython
* Online wxDocs
* New wxPyDocs
This is not good.
-> Does "New wxPyDocs" mean that the other ones are old and outdated?
-> What is the difference between "Online wxDocs" and other docs? Aren't the
others online too?
-> Which of these three links am I supposed to click on? I mean.. I do want
to learn wxPython, but I do want online docs, and I do want the new ones. So
which one is it?
These things need to be integrated and explained better. After clicking
around I can see that the latter two should probably be called "API
Reference". But there's still the issue of which one to pick.
SHHH....TTT I just realized that the "Online Docs" page is deceiving the
user into thinking that these docs are wxPython docs! This is just a frame
pointing to the wxWidgets docs!!!
If you click on "Oneline Docs" you get a page with a big huge title saying
"wxPython". Then you see what looks like a *sub*title* about wxWidgets with
a table of contents. This gives you entirely the wrong impression of what
this page is about and how it relates to the other pages!!
Ok, this is what I recommend for links (in order):
-> Learn wxPython
-> wxPython API Reference
-> wxWidgets Documentation
I fully appreciate and support this. It has bothered me before. Should
the last one, though, be "wxWidgets API Reference" to be consistent?
Really, I would prefer that there was only the wxPython API reference,
but the very best formatting of that. I think for at least beginner's
purposes, the wxWidgets API might be confusing, and if there is a
very good wxPython API reference it will be good enough to use just
that.
Now the user knows what to expect from each link, and why there should be
three links and not one.
Absolutely.
Che
···
On Fri, Jan 15, 2010 at 1:52 AM, Daniel Carrera <dcarrera@gmail.com> wrote:
> -> Does "New wxPyDocs" mean that the other ones are old and outdated?
> -> What is the difference between "Online wxDocs" and other docs? Aren't the
> others online too?
> -> Which of these three links am I supposed to click on? I mean.. I do want
> to learn wxPython, but I do want online docs, and I do want the new ones. So
> which one is it?
> These things need to be integrated and explained better. After clicking
> around I can see that the latter two should probably be called "API
> Reference". But there's still the issue of which one to pick.
> SHHH....TTT I just realized that the "Online Docs" page is deceiving the
> user into thinking that these docs are wxPython docs! This is just a frame
> pointing to the wxWidgets docs!!!
> If you click on "Oneline Docs" you get a page with a big huge title saying
> "wxPython". Then you see what looks like a *sub*title* about wxWidgets with
> a table of contents. This gives you entirely the wrong impression of what
> this page is about and how it relates to the other pages!!
> Ok, this is what I recommend for links (in order):
I fully appreciate and support this. It has bothered me before. Should
the last one, though, be "wxWidgets API Reference" to be consistent?
Really, I would prefer that there was only the wxPython API reference,
but the very best formatting of that. I think for at least beginner's
purposes, the wxWidgets API might be confusing, and if there is a
very good wxPython API reference it will be good enough to use just
that.
> Now the user knows what to expect from each link, and why there should be
> three links and not one.
-> Learn wxPython
-> wxPython API Reference
-> wxWidgets Documentation
I fully appreciate and support this. It has bothered me before. Should
the last one, though, be "wxWidgets API Reference" to be consistent?
Use whichever term is most accurate. The first goal is that the user know what to expect from each link. I just took a look through it, and it does look like an API reference. So I'm with you in "wxWidgets API Reference".