Well, first off, let's get a date chosen. As it turns out, Oct 23 is
looking to be a bad day. Are there any objects to Oct 30?

Secondly, it's time for me to rail about the docs. I was at least
somewhat negligent in letting them reach their current state. I didn't
do enough to police them. Right now, though? They suck. Again.

If you're interested in participating in the doc sprint, then here's
what I want you to do. Keep these scenarios in mind, and then take a
look at the docs. Ask where and how these questions would be answered
if you didn't already know where to look.

Scenario: I'm a brand new user to TurboGears. Why should I care about
it? What can it do to make my life better?

Scenario: I've gone through TurboGears boot camp. How do I get into
the more advanced pieces of developing applications for TurboGears?

Scenario: I'm very experienced, but I forget how to do this one
function call. Where's the signature for it?

Scenario: I'm pretty advanced. TurboGears is lacking something that
matters to me. How do I extend TurboGears and make it do what I need?

Now, with those scenarios in mind, take a look at our main docs page:
http://www.turbogears.org/2.1/docs/

How does anybody find their answers? How do people who don't already
know where to look get what they need, and get their problems solved?

As you can see, our docs simply suck. It's enough to make people walk
away. For the next week, my goal is going to be to redefine the
documentation structure. I want to reduce the amount of text on the
main page to a point that our users will be able to understand where
they need to look much more quickly. To that end, I'm also pondering
the introduction of page templates, wherein we can make the docs more
uniform in appearance, and improve their relevance to people seeking
answers.

My questions for all of you reading this: What are your scenarios?
What do you want and need out of the docs? What would help you find
your answers more quickly?

-- 
Michael J. Pedersen
My IM IDs: Jabber/[email protected], ICQ/103345809, AIM/pedermj022171
          Yahoo/pedermj2002, MSN/[email protected]

-- 
You received this message because you are subscribed to the Google Groups 
"TurboGears Trunk" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/turbogears-trunk?hl=en.

Reply via email to