[SeasonOfDocs] Motion: adopt a style guide

Clarence Cromwell clarencewcromwell at gmail.com
Wed Aug 7 09:20:04 PDT 2019


I move that we adopt the Microsoft Style Guide
<https://docs.microsoft.com/en-us/style-guide/welcome/> and the Merriam-Webster
<https://www.merriam-webster.com/>dictionary for The Good Docs project, and
that we apply them to whatever writing is generated by the project (our web
site and our official templates) but that we don't demand that anyone use a
guide for contributing a collection of templates, as they are source
material.

(I would emphasize that we only have to apply the style guide to material
before we publish it, so that doesn't even require that people learn it
before contributing; anyone who doesn't have the time, could allow an
editor to clean up contributions according to the style guide.)

Reasoning:

   - We need to all work from a single standard.
   - These guides are available for free online.
   - The Microsoft Guide is specific to technical writing, and is widely
   accepted in the industry.

If there are strong feelings about using a different guide, I would suggest
a counter-motion naming a specific set of books, so that people can vote
for one or the other, and then we can get on with business.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/seasonofdocs/attachments/20190807/a7735fad/attachment.html>


More information about the SeasonOfDocs mailing list