[documentation] Navegability in Drupal documentation

sime info at urbits.com
Sun Jun 25 14:51:03 UTC 2006


Hi Luiz

To start with, I don't think the Handbook is perfect. I find I am 
learning where things live as I go along. But here are some pointers for 
background reading so you can help improve things.

Regarding limitations of the handbook, for better or for worse we are 
using the book.module. For changes to the way this module works (which 
is basically what you are commenting on) we need people like you to 
lodge ideas in the support queue, and if you are really keen, sponsor a 
developer to submit patches as well.

Start with an overview of the book.module - 
http://drupal.org/handbook/modules/book
Then consider the 4.7 advanced search - http://drupal.org/search/node/
and you might agree that there is a lot going for us.

To suggest changes to the way book.module works, please submit your 
suggestions here:
http://drupal.org/project/issues?projects=3060&components=book.module&states=1,8,13,14,2

Some of your issues revolve around the "monolithic" book page structure. 
You might like to review the efforts towards that here:
http://drupal.org/node/65319

On a side note, I don't didn't like the examples you've provided below. 
Many of them are quite scattered, links going all over the place, with 
inconsistent styling. (For sake of discussion), the best on-line 
documentation I've used is at php.net.

Hope this helps
Simon



Luiz wrote:

> Mantainers, please, see these examples:
>
> http://dojo.jot.com/WikiHome
> http://www.rubyonrails.org/docs
> http://httpd.apache.org/docs/2.2/en/
> https://help.ubuntu.com/community/UserDocumentation
>
> Those design projects are practical and "clean", have "flowing links", 
> are rapid and efficient to found any information.
>
> I searched only few examples, and all have good navegability.
>
> This means the good navegability on documentation is crucial to any 
> system or project, and designers are very important in this task.
>
> For me Drupal is an exception with your "monolitic" book page 
> structure with confused left menus.
>
> Luiz
>
>
>
>     
>
>     
>        
> _______________________________________________________ Yahoo! doce 
> lar. Faça do Yahoo! sua homepage. http://br.yahoo.com/homepageset.html
> -- 
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/
>
>
>


More information about the documentation mailing list