Am 07.10.2010 19:40 schrieb Michael Pedersen:
Christoph: I'm still torn on the best layout. What you have there is,
essentially, what we already have. I'm not sure if it's the structure,
or if it's the content, but somehow we're not managing to communicate
clearly to our users.
One thing I changed was having three top level introductory sections
"Overview", "Getting started" and "Getting to know" which seemed to
much. I suggested using only one with section with subsection. Then the
"Getting started" section has 2 installations instructions, and there is
yet another section on installation on the homepage (separate from the
docs). That's also confusing.
Another thing I find confusing is the mishmash of table of contents,
navigation and repeating the nagivation in the page body. E.g. on the
front page there is a Table of Contents that looks more like a
navigation bar, and then you must scroll down only to see see the same
table of contents again in the page body. Even worse, if you click on an
entry in the Table of Contents, then you don't jump to the corresponding
content, but to the teaser entry on the same page.
Also, you never know in which part of the whole documentation tree you
are. I like to have a clear nagivation sidebar on all pages (maybe in
combination with bread crumbs) that always shows clearly where you are
inside the whole documentation tree. The PHP docs are a good example,
http://www.php.net/manual/en/. We can also learn from other known-good
docs, some of which are mentioned at http://stackoverflow.com/q/181421
> So, my plan? Develop templates and an actual documentation structure.
> Move the existing docs to an "old" area. Make the focus of the sprint
> into "Take docs from old, convert to use the appropriate template, and
> place correctly into structure." Our todo list would remain much the
> same, but the end result would be something that is so much improved
> that it could seriously help the overall image of TurboGears.
>
> What do you all think? Aside from me being batshit insane, is this
> something worth considering?
I think developing the templates and structure *and* rearranging the
docs would be too much for one sprint. Maybe somebody can come up with a
good solution before the sprint, so we can concentrate on the latter? Or
even 2 or 3 different solutions, and we can pick the best one at the
beginning of the sprint.
-- Christoph
--
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.
