Windows Mobile SDK Documentation Navigation Experiment


The good thing about bagels – in fact, one of the many good things about bagels, is that when I meet my friend Francis to share a few, we end up talking about lots of interesting stuff. We’re both in the SDK documentation field, and so we end up talking about how life is hard for technical writers, and wouldn’t life be better if we didn’t actually need help documentation in the first place (although we’d also be unemployed).


Today we had a chat about navigation and finding stuff, and Francis talked about his idealized Subway Map model.This set me thinking, and I created the following diagram – for which I haven’t yet made up an awesome sounding name – that lays out links to the Windows Mobile 5.0 API documentation. Rather than using the “Table of Content” approach (that few people claim to read) it’s all blobby and colour-coded. The image below should actualy work, as it’s an imagemap – so feel free to give it a try. Some of the links may be slightly iffy.


 


 


This lead me to consider the following: what if, at the top of every API documentation topic, you saw a little map that told you were you where, and provided a jump back to the diagram above so you could start drilling down a little more quickly. It might, in fact, look something like this:


What do you think?


One thing I know for certain – we currently make very poor use of the help delivery system. Using Ajax/JScript type tricks, we could make some considerably more flashy/interactive documentation tools. But that’s a story for another day.


Do please give me some feedback on my coloured blob help index system (CBHIS? Naw, that’s awful. Blob Index Map (BIM) – Hmm. Not bad).


 


Comments (5)

  1. John,

    It occurs to me that what you have there is very similar to the late binding of a tag, a.k.a. a cloud in the lexicon of the deli.cio.us folks.

    Your diagram looks a little like the King County Library catalog Go here:

    http://explorer.kcls.org/

    Enter "Kennedy, John" as an example.

    Your example is better than my abstract rambling about the idea. I’m no Mobile expert but it looks like it has merit to me.

  2. Mike Edwards says:

    The issue I tend to find most frustrating is losing the "back" functionality. It’s hard to move back up a tree once you’ve got down one, and it’s hard to figure out where you are. The upside of HTML help is that multiple pages can link to the same entry, and it’s the downside as well, as you can end up getting to the same page over and over.

  3. SDK writer says:

    How does subway mapping work? Essentially, once you are familiar with the basic concepts of the subway,

  4. Sébastien Mouren says:

    Your classification delivers new content domains.

    I find it more useful than the classic hierarchical approach. There is too much nesting in the hierarchical description and expressiveness of the relationship between a subject and a content is somewhat limited.

    A map is also a good way to represent complex relationship in a explicit way.

    Problems, I encounter with MSDN today, are:

    -it’s slow (I wait for a page for 2-20s in EU) to browse; reading about a subject requires you to browse (too?) many pages,

    -content availability is often a problem,

    -its search features are not competitive for my needs,

    -content organization is inflexible and limitative (see in the introduction).

  5. Susan Warren says:

    Color coded AND graphical?!  Obviously a winner, in my book.  🙂

    Though I would suggest that you flip things around a bit so that it’s more of a horizontal representation than a vertical one… make it match screen real estate.

Skip to main content