On Thu, Oct 7, 2010 at 3:46 PM, Christoph Zwerschke <[email protected]> wrote: > 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.
I'm still working on this. Trying to let my brain do what it does best: Get some idea of "what do I need", and give it a few days. There's too simple "we have one link on the main page!" and too complex "we have every link on the mainpage!". I know there's a balance. I'm just not sure where it is. Your three sections, though, might be about right. I think part of the key is making a decent front page for it all. Making that is hard, though. > 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. Definitely agreed. We've got too much happening in too many places on the screen. Getting around is an exercise in clicking too many times. My original goal was that, in no more than 3 clicks, you could reach any page. I think that is still a good goal. Not sure how easily attainable it is, though. > 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 Actually, that could be a very good model. My only objection is that their front page is too long. I feel that getting into the docs should be a single-screen item. Hmmm... Python's docs ( http://docs.python.org/ ) do this very well. I think maybe we should take a cue from them. > 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. Actually, I wasn't planning on doing all of that at the sprint. It's still at *least* two weeks away. That's enough time to get the structure and a few of the templates down. That would mean, come sprint time, we focus on transferring existing docs to new templates. -- 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.
