[documentation] [Documentation feature] Revolutionary, Innovative, Alternative approach to Drupal documenation?

voipfc drupal-docs at drupal.org
Thu Jan 4 01:53:43 UTC 2007


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

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

This is my idea of how Drupal documentation should be created. It is
further explained in this forum topic - A Revolutionary proposal for
creating documentation [1]  relating to this topic in another one Drupal
documentation: A constructive criticism.


The right approach here is not for everything to be created at
drupal.org, but for Drupal documentors to create a document outline,
with chapters, topics, and desired content specified. Even this part of
the process can involve the community.


Instead of real content there will be links to contributors websites,
probably wikis, where their versions of the topics will be created.
Readers can then vote on which ones are the best and Drupal documentors
can select which of them will go into the Official Handbook, which may
not necessarily be those with the top votes.


Drupal documentors can also create their versions, but in their own
sandbox, which are also linked to just like the others. It could even be
the case that some of the unofficial guides may be so much better than
what the Official guys are producing that they may even decide to apply
their efforts to those instead into the final Official version.


After some time each chapter or topic will be well fleshed out and the
best ones can make it into the Official Handbook. If the manual can also
be developed around a real or imaginary project, using a real website,
such as the new.drupal.org, that will also help.


The approach here is for progress to be through small but well focused
contributions, in well defined areas. Having thousands of cooks will
spoil the banquet, it the cooks are divided into small teams with well
defined tasks in preparing the banquet, you will end up with great
banquet.


One thing that we have to realise that Drupal is a moving target and
new versions may come about before the manual is completed. But so long
as the Drupal version involved one provides a strong enough foundation
for developers to work on, once they create a project with that version
they might even stick with it for good where that project is concerned.
Module breakage and all that.
In any case the links can point to the appropriate versions for newer
an older versions.


My message here to Drupal leaders is: create the structure, setup some
guidelines, provide some advice and control, and the community will do
the rest.


Many hands make light work.


Just as with modules, business can sponsor some pages by providing
staff or paying bounties to support their creation, and have their shiny
logos shining out brightly from the pages if they want.


The Component selected was Developer Guide which reflects my area, but
it is equally applicable to the User and Admin guides.
[1] http://drupal.org/node/106309#comment-185402




voipfc



More information about the documentation mailing list