[documentation] Re: [drupal.org] FAQ

Heine Deelstra info at ustilago.org
Fri Apr 28 07:30:31 UTC 2006


Now I've been thinking a bit longer about the FAQ I'm al for short  
sections linking to relevant pages in the handbook. That way we do not  
duplicate information (my submitted by example). In some cases it might be  
beneficial to have a longer answer, linking to many distinct pages in the  
handbook.

On Fri, 28 Apr 2006 08:16:13 +0200, Kobus Myburgh  
<ITBJDM at puknet.puk.ac.za> wrote:
> I do believe that sometimes the handbook information is distributed and  
> hidden and bloated, especially answers hidden in comments. I think this  
> means we have two options:

> 1. Do it the way you suggest, and let the user sift through the comments.
> 2. Rework the comments into the documentation pages (and possibly  
> rewrite the page).

The amount of answers among comments is exceptionally low. Ideally,  
relevant issues found among the comments should be incorporated into the  
handbook pages. This is what we've been doing for some time now, albeit  
slowly. That's why we have http://drupal.org/handbook/comments and why I  
relentlessly delete any irrelevant support question I see in the handbook.

However, it is a distinct task from creating a FAQ, and you don't have to  
tackle it entirely by yourself. Since this is supposed to be a  
documentation *team*, why not post issues  
(http://drupal.org/project/issues/documentation) against pages you find  
unsatisfying?

Regards,

Heine


More information about the documentation mailing list