[OLPC library] [support-gang] style guide (Re: 2012 Doc Sprint Plan [jump in on library at lists.laptop.org !])

[Christoph Derndorfer]

On Fri, Apr 6, 2012 at 3:25 AM, <spage at monkeybrains.net> wrote:

> >          Rather than FLOSS Manuals, "chapters" will be hosted at
> > http://wiki.sugarlabs.org and http://wiki.laptop.org using WISYWIG
> > plugins (SJ&BernieI will each try to install today)
>
> >          Chapters MUST abide by Style Guide to be posted today, so
> > screenshots/grammar flow (Seth & Christoph)
>
> There is already a style guide for the wiki,
> http://wiki.laptop.org/go/OLPC:Style_guide , and Help Activity Refresh
> wasn't following it.
>
> * Don't use H1 headings, i.e. start with == My heading ==, not =This
> appears as H1=. The page title is an H1, and should be the only one on the
> page.
>
> * Don't overcapitalize. Only capitalize the first word of a title.
> Section headings like "Procedures on Porting/Assembling the Manual into
> Help Activity" just sound Officious and Wordy.  "Help Activity" is
> arguably appropriate capitalization, but other words should not be
> capitalized.
> I fixed these, if anyone strongly disagrees you can revert, but man up and
> change the style guide.
>
> Looking at laptop.org/manual, it's inconsistent. Its Chapter titles
> Capitalize Each Word, but sections Only capitalize the first word, like
> the wiki.  (The Flossmanuals house style turns the entire TOC into AN
> ILLEGIBLE ALL CAPS WHITE ON ORANGE, but that's a separate issue).
>
> Good luck with the doc sprint!  I'll try to check in and offer wiki help.
>

Personally I'm for option #4 "Lots of Capitalized Words" but maybe that's
just my native German determining my thinking... ;-)

Christoph

-- 
Christoph Derndorfer

volunteer, OLPC (Austria) [www.olpc.at]
editor, OLPC News [www.olpcnews.com]
contributor, TechnikBasteln [www.technikbasteln.net]

e-mail: christoph at derndorfer.eu
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.laptop.org/pipermail/library/attachments/20120406/c36b4579/attachment.html>