[drupal-docs] Where can I best help with docs?
Dries Buytaert
dries at buytaert.net
Sat Jan 8 09:52:12 UTC 2005
Steve Dondley wrote:
> I'd really like to help with the docs to help clear up some of the more
> confusing stuff. Can anyone make recommendations as to which
> section/page I should begin?
- The 'installation' section (node #252) in the Administrator's guide is
way too bloated. Some pages are buried 6 levels deep! I'd say that 4
levels (Handbook > Chapter/Guide > Section > Subsection) is about
maximum. I'd make that an official guideline and flatten the
organization of that section.
- The 'configuration' section (node #363) in the Administrator's guide
looks incomplete and fairly random. It contains 'hacks' (quite a few
pages contain PHP snippets?!) and advanced configuration stuff
(congestion control) but not newbie-level information that is task- or
problem-driven.
Also, I find pages like 'Adding syndicated content to your site' (node
#373) and 'Congestion control: tuning the auto-throttle' (node #4342)
long-winded. On the web you need to be brief and to the point because
otherwise no one is going to read your documentation. Having a page
explain each single form element of a GUI is boring. Furthermore, such
explanations are already available on the GUI itself (or should be).
--
Dries Buytaert :: http://www.buytaert.net/
More information about the drupal-docs
mailing list