[FM Discuss] Style guide

[Anne Gentle]

Hi Michael -
For the SugarLabs/OLPC books, we use the "Writing Conventions" link for the
book as our style guide and contribution guide. From this page,
http://en.flossmanuals.net/bin/view/XO/WebHome, click "Agreed conventions
for writing this
manual<http://en.flossmanuals.net/bin/view/XO/WritingConventions>
"
http://en.flossmanuals.net/bin/view/XO/WritingConventions. Is this the type
of style guide you're thinking of?

I think style guidance is very useful to get consistent, quality results.
Plus anyone approaching the manual has an idea of the conventions used to
write it and can contribute more quickly.

Hope this helps,
Anne


 *Anne Gentle*
annegentle at justwriteclick.com my blog <http://justwriteclick.com> | my
book<http://xmlpress.net/publications/conversation-community/>|
Twitter <http://twitter.com/annegentle>



On Thu, May 28, 2009 at 7:38 AM, Michael McAndrew <michaelmcandrew at gmail.com
> wrote:

> Hi all,
>
> During/after the CiviCRM book sprint we coalesced - to a certain extent at
> least - around a specific style that gives the CiviCRM book some coherence.
>
> I think it would be useful to make this explicit somewhere as an aid to
> people that want to contribute.  We could add to the 'How to contribute to
> this manual' section.  But it might sit better outside of the flow of the
> book.
>
> I wondered if any other books have had similar thoughts and experience.
> And if anyone has ideas about how the floss manuals infrastructure can help
> us do this / ideological objections to style guides?
>
> Cheers,
>
> Michael
> _______________________________________________
> Discuss mailing list
> Discuss at lists.flossmanuals.net
> http://lists.flossmanuals.net/listinfo.cgi/discuss-flossmanuals.net
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.flossmanuals.net/pipermail/discuss-flossmanuals.net/attachments/20090528/51196813/attachment.htm>