[documentation] Moving directory
Lee Hunter
lee.hunter at hum.com
Sun Oct 12 15:51:35 UTC 2008
I actually think we've gone down the wrong track with these kind of
headings. I call them "mystery headings" because they don't offer any
indication of the actual content they contain.
"Theme Guide" works well as a heading because it's clear that I'm
going to find information about theming. On the other hand, "Howto",
"Tutorial", "FAQ", "Best Practices" etc are all poor headings because
they are so vague and meaningless that they can, and do, address any
topic under the sun including theming, installation, hosting,
development, using modules, etc.
Any time I go to the documentation, I go there to address a very
specific problem. For example, if I'm trying to get my server set up
properly, I'd want to see all the server stuff in one place (under a
heading that clearly tells me that it's server stuff) and see it
presented in a logical order, according to task. Since the hosting
configuration stuff is scattered all over the place, I have to go to
"Howtos" to see if someone has written a howto, then go to "FAQs" to
find out if there's a FAQ, then go to "Tutorials" to see if there's a
server tutorial, then go to "Best Practices" to see if maybe there's a
server best practice and even then I'm not sure if there might be
more information hiding elsewhere.
Lee Hunter
Senior Technical Editor
On Sun, Oct 12, 2008 at 11:15 AM, Wolf Zirbs <wolf.zirbs at gmail.com> wrote:
> With all respect Lee, Seeing it from the point of view of a beginner that
> lands on the support page,
> in FAQs he would definitely want to see general Information
> in How-to's he would want to get some help in the basics of Drupal
> functionalities
> in Best Practice he will find more complex and technical information on
> Drupal Site implementation.
> I have to premise that I had not read and go throughout all the mentioned
> Sections
More information about the documentation
mailing list