Em Terça 02 Maio 2006 09:08, Michele Cella escreveu:

> I would like to hear your opionion regarding how our docs are actually
> organized, personally I find the *big* index of content too much book
> oriented, it doesn't fit so well inside the web and it's quite
> intimadatory for the newbie, that was my first impression at least.

My main concern is not that.  Is that some content looks like missing 
information that was available in our Trac.  One example is the Apache 
integration documentation.  The new one is at 
http://www.turbogears.org/preview/docs/installation_and_deployment/ApacheIntegration.html
but it misses information from, e.g., 
http://trac.turbogears.org/turbogears/wiki/RedirectHttpsRequests -- in the 
end I mention how to use mod_proxy to solve the HTTPS problem, but it applies 
to a common HTTP connection as well.

I believe that first of all information should be consolidated and only then 
it should be sent to our website as official documentation.  The way it is it 
is too fragmented and this is what leads to the problem you saw.

> What I find way more friendly and appealing is the concept of task
> based documentation, for example instead of presenting a link like
> "tg-admin" we should use something like:
>
> "Managing your application from the command line"
>
> or identity:
>
> "Adding authentication support to your application"
>
> and so on.

I agree with this.

> I'm sure you get the point, I really dislike the index of content
> style, it's pretty difficult to search what you're looking for when
> what you want is searching for the way you have to do a particular
> thing.
>
> Opinions?

I'd first consolidate docs and then we could have better names for then.  
Without this consolidation it will be harder for a user to find something -- 
it is now, but there's a "search" button that helps a little.

-- 
Jorge Godoy      <[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
-~----------~----~----~----~------~----~------~--~---

Reply via email to