Hi Pieter,
I took a quick look at the "Collaborating with Others" chapter of the
GSG and it's much improved now with the sub-sections called out at
the top of the page.
Clicking around, I was somewhat confused with the navigation.
1. The "How Do I" list are sub-sections of the Chapters listed on the
right-hand side...but it's challenging to keep the sub-section
numbers and the chapter numbers straight. Katie suggested that it
might be clearer if we used a Major.Minor numbering system. So for
"Collaborating with Others", which is Chapter 5, the sub-sections
would be labeled 5.1, 5.2 and 5.3.
2. We should further reinforce the numbering system by labeling the
titles of the sub-sections with their corresponding numbers. 5.1:
Chandler's approach to collaboration. I think this is especially
necessary because we don't have a way to highlight in the list, which
sub-section you are currently looking at.
As an aside: 5.1 should probably be either "Understanding Chandler's
approach to collaboration" or just simply "Chandler's approach to
collaboration". I think "Understand Chandler's approach..." sounds
like an imperative.
3.The 3rd sub-section is a cross-link to a sub-section of the
previous Chapter. So it shouldn't be enumerated.
4. The 4th sub-section is actually just a link to the next Chapter,
6. So shouldn't be labeled as a sub-section.
(I don't think you need this in the sub-section list at all, given
that the full list of chapters is ever-present on the right-hand side
and you provide a link to the next chapter at the bottom of the page.)
Actually, should the link at the bottom of 5.1, take you to 5.2 and
5.2 take you to 5.3?
===
Proposed titling scheme:
5.1 Chandler's approach to collaboration
5.2 Schedule an informal activity
5.3 Collaboration Use Cases
===
5. The "What is Chandler?" section at the top of the "Chandler's
approach to collaboration" section seemed out of place. Similarly,
the "Chandler Target User" section at the top of the "Collaboration
Use Cases is out of place. The title at the top of these two pages
should match the titles I clicked on in the list.
6. I find the jump-linking effect a bit disorienting. Since each of
the sub-sections is its own page, I wonder if the jump-linking is
necessary. I actually think it helps to keep the sub-section list in
view as I navigate. It helps me maintain a sense of context. The jump-
link effect misleads me into think that I just jumped down the page,
but then when I scroll up, the content I used to see isn't there
anymore.
Mimi
On Sep 4, 2007, at 11:43 AM, Katie Capps Parlante wrote:
I spoke with Pieter on Friday about next steps for the Getting
Started Guide, and here is what we came up with:
- Chapter on Triage Workflow (using Mimi's input)
- Chapter on Calendaring (Bug 10412)
- Glossary
- Index (basically a list of the "How do I?" headings)
- Final sweep of copy edits
- Final sweep updating links (Bug 10706)
Pieter expected this work to take ~1 week.
In general I'm looking to wrap up most doc tasks by Sept 10 (next
Monday).
Cheers,
Katie
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
Open Source Applications Foundation "General" mailing list
http://lists.osafoundation.org/mailman/listinfo/general
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
Open Source Applications Foundation "General" mailing list
http://lists.osafoundation.org/mailman/listinfo/general
