[documentation] Re: documentation Digest, Vol 14, Issue 35

Chris Johnson chris at tinpixel.com
Thu Jan 12 16:43:30 UTC 2006


> Date: Wed, 11 Jan 2006 22:30:15 -0800
> From: Boris Mann 
> Subject: Re: [documentation] Documentation session in Vancouver
> To: A list for documentation writers <documentation at drupal.org>

>>* How can we more efficiently store help documentation for modules  
>>rather than placing text inside the files themselves?
> 
> 
> This one is in part a development question. I had attempted to start  
> this discussion, and it became a developers want it this way,  
> documentation writers need it to work this other way discussion.
> 
> I'd love to see documentation a) be self hosted on top of Drupal  
> itself (i.e. we use Drupal to create/maintain the documentation and  
> b) make it easy for non-developers to update and include with  
> modules. No real answers there, lots of discussion needed, I think.  
> Actually, I'd love to look more at what other projects do and see  
> about finding some best practices....


This sounds good to me.  As a developer, I then want to know -- in the ideal 
world, what kind of development changes need to occur to make this not just 
work, but be great?  Or more specifically, do we need a documentation module, 
and if so, what would it look like?


Chris Johnson



More information about the documentation mailing list