[drupal-docs] Styleguide
Anisa
mystavash at animecards.org
Mon Apr 25 17:55:31 UTC 2005
For reference, the mysql docs are consistently capitalized (little words
are not) http://dev.mysql.com/doc/mysql/en/index.html
PHP docs are not as consistent, but mostly so http://www.php.net/manual/en/
Mozilla seems to be the same as php http://www.mozilla.org/developer/
I'm a little more liberal artsy myself, and that's certainly true.
However, I have no preference, except that it be consistent.
Anisa.
Shane Birley wrote:
> Isn't it proper to have capitalization in documentation if it is a
> heading of a section? I have noticed for years that programmers and
> the like seem to shy away from it. But, when you have people like me
> who are both nerd and hold degrees in language and language arts, it
> is customary to have titles that have capitals.
>
> Just my thoughts...
>
> S
>
>>
>> On 25 Apr 2005, at 15:58, Charlie Lowe wrote:
>>
>>> "Use short descriptive titles to label your handbook entry. Avoid
>>> redundancy; it is not typically necessary to use the word Drupal or
>>> Handbook in your title since you are already obviously talking about
>>> Drupal and your documentation is already obviously a part of the
>>> Handbook."
>>
>>
>>
>> Also, don't capitalize each word in your titles/headings. For
>> example, write "Modules and features" not "Modules and Features".
>> Can we add that to the style guide?
>>
>> --
>> Dries Buytaert :: http://www.buytaert.net/
>>
>
More information about the drupal-docs
mailing list