[drupal-docs] Troubleshooting FAQ

Kieran Lal kieran at civicspacelabs.org
Thu Mar 10 20:24:17 UTC 2005


I think we have a responsibility to both provide some leadership and to 
raise the quality of documentation in open source software.

In my opinion the postings combined with documentation present an 
overwhelming experience for new comers.  I think a wiki is a much 
better place for collaborative document editing.

I would encourage you to consider tackling smaller projects.   A 
smaller project can push what is expected in of documentation in open 
source software.  Troubleshooting for a system as complex as Drupal and 
dependent on so many variables is a very large task.  Perhaps if we 
focused on a smaller subset and tried to raise the quality of the 
documentation in a few specific areas we could provide the community 
with a benchmark of how good it can be.

Something narrow such as Trouble Shooting menus, or blocks with 
excellent visual examples and links to live sites could be very 
valuable.   I believe that a focus on quality will attract people who 
want to participate on higher quality project the way we have seen high 
quality developers get attracted to Drupal Core.

Thoughts?

Kieran
On Mar 10, 2005, at 11:15 AM, Richard Eriksson wrote:

> We are going through http://drupal.org/node/199 to determine what the
> questions really are, making a wiki page listing the questions, then
> we will make fully qualified book pages either answering the question
> or pointing (linking) directly to an existing book page.  We're
> listing the questions and adding one-line summaries or links to
> existing Drupal docs.   (See link below.)   This is probably a bit
> redundant (since we will need to create the actual book pages), but
> I'd like it to be an actual FAQ rather than forum questions added to
> the book page and then answered (maybe) in the comments.  Let us know
> what you think of that.
>
> We made the 'decision' to do that this morning during our weekly
> documentation sprint.  We haven't modified or added any Drupal pages
> yet just because we'd like to put on a wiki page what we think are the
> questions, where we think the question is already answered, and where
> the answers need to be taken from comments to a node-level page.  Let
> us know if you think there's a better approach, but--speaking just for
> myself here--I think having forum posts in the documentation is not as
> good as having questions asked in those forum posts answered in book
> pages.
>
> http://dev.bryght.com/t/wiki/TroubleshootingFaq
>
> -- 
> Richard Eriksson
> Bryght Community Support
> http://support.bryght.com/
> -- 
> [ drupal-docs | http://lists.drupal.org/listinfo/drupal-docs ]
>




More information about the drupal-docs mailing list