Drupal.org redesign – a strategy for the documentation section in planet drupal on November 19, 2008 November 20, 2008 with 20 Comments Share Facebook Twitter Pinterest Google+ Email Leisa Reichelt:15:36:39 ok. here’s the theory Leisa Reichelt:15:36:49 drupal documentation is essentially like wikipedia Leisa Reichelt:15:36:53 lots of pages Leisa Reichelt:15:36:59 it’s not hierarchical Leisa Reichelt:15:37:06 because it is grouped around so many things Leisa Reichelt:15:37:14 so doing a hierarchical IA for it is nonsense Leisa Reichelt:15:37:23 will only show how complex it is and where it is incomplete Leisa Reichelt:15:37:25 which we want to avoid Leisa Reichelt:15:37:30 hence our emphasis on search Mark Boulton:15:37:32 yep – agree with that Leisa Reichelt:15:37:44 ok, that’s the first part of the strategy Leisa Reichelt:15:37:46 here’s the next Leisa Reichelt:15:37:53 there are three key pathways to documentation content Leisa Reichelt:15:38:01 1. i have a specific problem I need an answer to Leisa Reichelt:15:38:05 in which case, i search Leisa Reichelt:15:38:16 2. i’m new at drupal, or some aspect of drupal and I need to get up to speed Leisa Reichelt:15:38:31 in which cse, i need access to some ‘designed’ content (eg. tutorials) Leisa Reichelt:15:38:37 and I’m likely to hit the docs landing page Leisa Reichelt:15:38:52 or 3. i need more information about <x> which I am looking at now Leisa Reichelt:15:39:02 eg. I want to see the documentation associated with this module that I might choose Leisa Reichelt:15:39:12 in which case, I want to see the documentation contextually linked Leisa Reichelt:15:39:21 convincing so far? Mark Boulton:15:39:27 absolutely Leisa Reichelt:15:39:30 ok Leisa Reichelt:15:39:38 so, pathway A is covered already Leisa Reichelt:15:39:54 pathway C is also covered (although we’ll need to check for other places where contextual linking is appropriate) Leisa Reichelt:15:40:02 pathway B is the tough one Leisa Reichelt:15:40:13 because what *is* this section if we don’t have hierarchical navigation? Leisa Reichelt:15:40:24 what do we have to draw inspiration from? Leisa Reichelt:15:40:30 wikis, of course! Leisa Reichelt:15:40:55 so, the sub navigation for docs becomes something like: docs home | API | Index | Recently Updated Mark Boulton:15:41:03 makes a lot of sense Leisa Reichelt:15:41:10 API needs to be kept separate I think Leisa Reichelt:15:41:21 and we can play around with exactly how the INdex works Leisa Reichelt:15:41:37 and then the landing page of docs is all for new people needing structured guidance Leisa Reichelt:15:41:52 so it links off to whatever of this we have available Mark Boulton:15:41:58 sort of orientation Leisa Reichelt:15:42:00 including, I think, the recipes? Leisa Reichelt:15:42:07 yes, indeed. Mark Boulton:15:42:19 I like it – it solves the problem Leisa Reichelt:15:42:24 and there are two main kinds of documentation pages Mark Boulton:15:42:40 plus it gives the freedom to the community to tailor it to their needs as they evolve Leisa Reichelt:15:42:43 the actual documentation, and then a more flexible ‘index’ template that people can use to group documentation in whichever way they like Leisa Reichelt:15:42:52 exactly Leisa Reichelt:15:43:16 and, it doesn’t make it look as though there is too much/too little documentation at a glance Mark Boulton:15:43:28 exactly – the holes aren’t as visible Leisa Reichelt:15:43:35 exactly Leisa Reichelt:15:43:38 ok. Mark Boulton:15:43:47 I might do a dance now Mark Boulton:15:43:50 :) Leisa Reichelt:15:44:00 lol Share This Previous Post← Drupal.org redesign – Cardsorting Module Categories Drupal.org redesign - Cardsorting Module Categories Next PostDrupal.org redesign â€“ why is it so? Some insights into our design strategies. → Drupal.org redesign â€“ why is it so? Some insights into our design strategies. You May Also Like on August 24, 2011 Prairie Initiative Update at Drupalcon London on October 27, 2008 Drupal.org – talking about the redesign project at the Web 2.0 Expo in Berlin on October 7, 2008 Drupal.org – Crowdsourcing Usability Testing – Get Involved!