Re: v0.3 of Styleguide

Here are more suggestions. Most of them are from
GDP style guide but it does no harm to repeat them here: 

- lines should be wrapped at  80 chars or shorter

- in titles (of chapters, sect1's, sect2's,...) all words other than
  articles should  be  capitalized 

- titles should not end with the period

- we should use American English: "color", not "colour". I am not saying
  that American is better than British (I am Russian so I am neutral)
  but we definitely need to use the same dialect of English throughout
  the   docs, and it seems that more people prefer American. British
  can create localized version of the docs in locale en_GB

- we use standard names for keys on the keyboard: 
  <keycap>Ctrl</keycap> (not "control key")
  <keycap>Enter</keycap> (or <keycap>Return</keycap>?? Need to decide

Also, a suggestion: typing <application>Gnumeric</application> is way
too long. Why don't we define an entity, e.g. 
ENTITY gnumeric "<application>Gnumeric</application" 
so that we can just type &gnumeric;


On Thu, 2002-01-03 at 13:21, Kevin Breit wrote:

    After next to no discussion about v0.2, v0.3 of the styleguide is
    out.  Please read it.  If you have grips with it, read it now


Kevin Breit  Documentation Writer 
Ximian, Inc. 
mrproper ximian com

[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]