[documentation] [Documentation feature] taxonomy pages rewrite/reorganization

rivena drupal-docs at drupal.org
Tue Jun 6 19:25:13 UTC 2006


Issue status update for 
http://drupal.org/node/67616
Post a follow up: 
http://drupal.org/project/comments/add/67616

 Project:      Documentation
 Version:      <none>
 Component:    Admin Guide
 Category:     feature requests
 Priority:     normal
 Assigned to:  Anonymous
 Reported by:  rivena
 Updated by:   rivena
 Status:       active

I've thought this for a long time, but wouldn't be neat if the handbook
were like drupal code?  Each page a little essential function, complete
in and of itself.  When it needed another function, it would reference
another page, rather than be redundant and make more code.


Looking at the taxonomy pages
(http://drupal.org/handbook/modules/taxonomy) reminded me of that;
there were three different places where it described different kinds of
vocabulary structures, but they were written from 3 different
perspectives that make it difficult to extract.


So, I suggest a rewrite that creates more little pages that are focused
on one specific topic.  If there is additional material, let that be
another page. My suggested outline:


---------------
Taxonomy main page: Should be cut down.  More 'you can's.  Less self
promotion, and add some basic description about each kind of vocabulary
function.  Lingo used should be standardized (discussion needed).


Different kinds of vocabularies (flat, hierarchical, free tagging)


HOWTO: Create a vocabulary


HOWTO: Create a term


Contributed modules comparison (Taxonomy Garden) (should clearly state
that these are contrib, not core, that some may not be updated, modules
whose function has been put into core should be removed)


Useful code snippets


More on Taxonomy (storytelling/Long version; all techincal details
should be left to other pages; this should be about case examples and
detailed explanation, what about an introduction, and then at least 3
case examples of when it's appropriate to use a kind of vocabulary?)


---------------


Anyway, just a thought.  The main thing is to reduce redundancies and
make it more clear to the end user what each page is for.  Each page
should be able to function independantly, without restating what
another page says.  I started re-writing the taxonomy main page, will
put that through later.


Anisa.




rivena



More information about the documentation mailing list