[drupal-docs] Task for Drupal documentation writers

mystavash at animecards.org mystavash at animecards.org
Mon Apr 4 03:16:41 UTC 2005


Hm.  Well, suggestions I have not read the documention writers guide aside, I
think Jaza's link is a very good one that makes the point there's too much
wordiness.

The main reason I suggest coming up with a style now is because also recently on
the devel list, someone went through all the module descriptions and rewrote
them to be consistent. Those are just one - liners, too.  

The help texts that are up for discussion are short, and consistency can be
acheived without going all the way and writing a style sheet for them.  It'll be
interesting, a mini-experiment to see what is effective in the space given.

Anisa. 

Quoting bryan on the web <digital at mysteryexperience.com>:

> 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.
> 
> bryan
> --
> [ drupal-docs | http://lists.drupal.org/listinfo/drupal-docs ]
> 








More information about the drupal-docs mailing list