[drupal-docs] Styleguide

[puregin]

We could familiarize ourselves with some existing style guides (or
steal them outright :)

For example:

http://www.oreilly.com/oreilly/author/stylesheet.html

There's much other information of interest at the O'Reilly site.

On 24 Apr 2005, at 3:56 AM, Anisa wrote:

> Currently established style guide (http://drupal.org/node/15289):
>
> 	• 	Don't use the words 'Drupal' or 'Handbook' in page titles
> 	• 	Use ordered lists for step by step instructions.
> 	• 	When directing someone to a place in their Drupal install, use 
> this format: destination (<i>path &gt; to &gt; item &gt; 
> destination</i>) (which will look like this: destination (path > to > 
> item > destination))
> 	• 	When directing someone to a place in their drupal install, do not 
> abbreviate.
> 	• 	If you refer to a module/theme/whatever, link to it once, but not 
> too many times.
> 	• 	Enclose code samples within <code> tags.
> 	• 	Links should be embedded within normal descriptive body text.
> 	• 	Links should use this format: <a href="node/1234567" 
> title="information">
> 	• 	Always spell check
>  I would add the following:
> 	• 	When refering to a place in a drupal install, always include the 
> actual drupal path. (ex. not just path > to > item > destination, but 
> also admin/node/configure)
> 	• 	Include references to relevant or related pages as much as 
> possible.
> 	• 	Keep to the topic in the document.  If you are writing on topic C, 
> and C requires knowing about A and B, make seperate pages for A and B.
>  Anisa.
>  sleepy.
>
>
> -- 
> [ drupal-docs | http://lists.drupal.org/listinfo/drupal-docs ]
>