[drupal-docs] Task for Drupal documentation writers

[Ron Mahon]

 Nielsen's rules duplicate the rules for copywriting. After the goals are
the same let the reader understand what written.


InterNet Marketing Resource Center
A Free Super Mart of Articles, Demos, Tutorials everything you need to
Succeed on the net.
www.inmrc.com 


-----Original Message-----
From: Jeremy Epstein [mailto:jazepstein at gmail.com] 
Sent: Sunday, April 03, 2005 9:50 PM
To: drupal-docs at drupal.org
Subject: Re: [drupal-docs] Task for Drupal documentation writers

On Apr 4, 2005 1:52 AM, bryan on the web <digital at mysteryexperience.com>
wrote:
> On Apr 3, 2005, at 9:36 AM, mystavash at animecards.org wrote:
> 
> > Stefan has a good start with his expectations below, but I remember 
> > reading sometime on the devel list someone objected to the use of 
> > the phrase 'click on...' so I wonder...  there seem to be informal 
> > writing guides people enforce inconsistantly.  If we make one style 
> > guide for each type of text, things can only get better, and at 
> > least we're not propagating the kinds of errors we want to prevent.
> 
> <pleasant sarcasm>RTFM</pleasant sarcasm>, This sort of exists already
> at:
> 
> Home > Drupal handbook > Documentation writer's guide
> http://drupal.org/node/15289
> 
> Let's work from this an update it more if need be.
> 

The "authoring guidelines" page has some good solid tips, but I think Anisa
is right in saying that there's a lot of "informal rules" that aren't
written down, and that still need to be documented.

Perhaps we should also provide a link to Jakob Nielsen's "Writing for the
Web" article (http://www.useit.com/alertbox/9710a.html) from the "authoring
guidelines" page. This article covers some very basic things that are
obvious to some, but too-oft forgotten by many.

Jaza.