<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<div class="moz-cite-prefix">Sharing Sarah's response, with
permission ...</div>
<div class="moz-cite-prefix"><br>
</div>
<div class="moz-cite-prefix">On 12/8/19 9:07 am, Sarah Maddox wrote:<br>
</div>
<blockquote type="cite"
cite="mid:CAEyDeRu-Vyd+UQhbDfHo3+56p8WMyE00juUEBbp3_qNFreBq1A@mail.gmail.com">
<div dir="ltr">
<div class="gmail_default"
style="font-family:tahoma,sans-serif;color:#674ea7">Hallo
Cameron</div>
<div class="gmail_default"
style="font-family:tahoma,sans-serif;color:#674ea7"><br>
</div>
<div class="gmail_default"
style="font-family:tahoma,sans-serif;color:#674ea7">I think
it'd be fine for The Good Docs Project to list a few
recommended style guides and let people choose the one that
suits their use case best. The most important thing is
consistency within a doc set, to give readers a smooth ride
through the text. I don't think we can aim for consistency
across all open source doc sets.</div>
<div class="gmail_default"
style="font-family:tahoma,sans-serif;color:#674ea7"><br>
</div>
<div class="gmail_default"
style="font-family:tahoma,sans-serif;color:#674ea7">I'd like
to know what others think!</div>
<div class="gmail_default"
style="font-family:tahoma,sans-serif;color:#674ea7"><br>
</div>
<div class="gmail_default"
style="font-family:tahoma,sans-serif;color:#674ea7">Cheers</div>
<div class="gmail_default"
style="font-family:tahoma,sans-serif;color:#674ea7">Sarah</div>
</div>
</blockquote>
<div class="moz-cite-prefix">On 12/8/19 1:20 pm, Clarence Cromwell
wrote:<br>
</div>
<blockquote type="cite"
cite="mid:32DC5D77-A09B-4BCE-A7FA-8D576DB704EB@gmail.com">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<br>
We don’t need to push everyone in the world into one guide, but we
need to choose one for internal consistency.
<div>We shouldn’t be using different spelling rules and comma
rules from one another as we contribute to these docs.</div>
<div>I don’t mean to suggest one guide to rule them all.</div>
<div>:-)</div>
<div>I agree with having a list of recommended guides, which
should include both of these options.</div>
<div><br>
<div id="AppleMailSignature" dir="ltr">Sent from my iPhone</div>
<div dir="ltr"><br>
On Aug 11, 2019, at 5:39 PM, Felicity Brand <<a
href="mailto:felicitybrand@gmail.com" moz-do-not-send="true">felicitybrand@gmail.com</a>>
wrote:<br>
<br>
</div>
<blockquote type="cite">
<div dir="ltr">
<div dir="ltr">
<div>
<div>I'm not too fussed on which one we choose - but
from a selfish perspective I have recent experience
using Microsoft and Apple styles so they are familiar
to me (and it's all about ME). <br>
</div>
<div><br>
</div>
<div>I think tGDP need to choose a style guide for our
own website and templates that we produce - and
explain why we chose it.</div>
<div><br>
</div>
<div>I think anything more than that should just be a
curated list of style guides so that folks can choose
one appropriate for their context.</div>
</div>
<div><br>
</div>
<div>The intent of moving them toward a universal guide
strikes me as kind of Orwellian. So I had to smile when
I saw that Google has a quote from Orwell <a
href="https://developers.google.com/style/"
moz-do-not-send="true">on their page</a>. </div>
<div><br>
</div>
<div>Or perhaps this idea is more like Tolkien? <i>One
style guide to rule them all.</i></div>
<div><br>
</div>
<div>I am not convinced that a universal style guide could
(or should) ever exist, because writing totally depends
on context. </div>
<div><br>
</div>
<div><br>
</div>
</div>
<br>
<div class="gmail_quote">
<div dir="ltr" class="gmail_attr">On Mon, Aug 12, 2019 at
6:49 AM Cameron Shorter <<a
href="mailto:cameron.shorter@gmail.com"
moz-do-not-send="true">cameron.shorter@gmail.com</a>>
wrote:<br>
</div>
<blockquote class="gmail_quote" style="margin:0px 0px 0px
0.8ex;border-left:1px solid
rgb(204,204,204);padding-left:1ex">
<div dir="ltr">Clarence, others, why would I choose one
of the other? You might want to answer this question
for other guides as well.
<div>If we were to approach the owners of style
guides, such as Google/Microsoft/Wikipedia, with the
intent of moving them toward a universal guide, what
should we say to them?</div>
<div><br>
</div>
<div>Do the people here have opinions on this? I'm
hoping so.</div>
</div>
<br>
<div class="gmail_quote">
<div dir="ltr" class="gmail_attr">On Mon, 12 Aug 2019
at 04:11, Clarence Cromwell <<a
href="mailto:clarencewcromwell@gmail.com"
target="_blank" moz-do-not-send="true">clarencewcromwell@gmail.com</a>>
wrote:<br>
</div>
<blockquote class="gmail_quote" style="margin:0px 0px
0px 0.8ex;border-left:1px solid
rgb(204,204,204);padding-left:1ex">
<div dir="ltr">
<div>Here are both guides in one place. </div>
<div><br>
</div>
<div>Google: </div>
<a href="https://developers.google.com/style/"
target="_blank" moz-do-not-send="true">https://developers.google.com/style/</a><br>
<div><br>
</div>
<div>Microsoft: </div>
<div><a
href="https://docs.microsoft.com/en-us/style-guide/welcome/"
target="_blank" moz-do-not-send="true">https://docs.microsoft.com/en-us/style-guide/welcome/</a><br>
</div>
</div>
<br>
<div class="gmail_quote">
<div dir="ltr" class="gmail_attr">On Sun, Aug 11,
2019 at 11:00 AM Clarence Cromwell <<a
href="mailto:clarencewcromwell@gmail.com"
target="_blank" moz-do-not-send="true">clarencewcromwell@gmail.com</a>>
wrote:<br>
</div>
<blockquote class="gmail_quote" style="margin:0px
0px 0px 0.8ex;border-left:1px solid
rgb(204,204,204);padding-left:1ex">
<div dir="ltr"><br>
<div>Both of the guides offer good writing
tips and have useful information about how
to document APIs. Does anyone have strong
feelings about one guide or the other?</div>
<div><br>
</div>
<div><br>
</div>
<div><br>
</div>
<div><br>
</div>
</div>
<br>
<div class="gmail_quote">
<div dir="ltr" class="gmail_attr">On Wed, Aug
7, 2019 at 1:08 PM Cameron Shorter <<a
href="mailto:cameron.shorter@gmail.com"
target="_blank" moz-do-not-send="true">cameron.shorter@gmail.com</a>>
wrote:<br>
</div>
<blockquote class="gmail_quote"
style="margin:0px 0px 0px
0.8ex;border-left:1px solid
rgb(204,204,204);padding-left:1ex">
<div bgcolor="#FFFFFF">
<p>I've change title to "Not a Motion
yet". I can see that we have a
difference of opinions, which is fine. I
think this is an important topic for a
tech writing project, and I would love
to see robust and wide discussion about
it for at least a week, possibly more.<br>
</p>
<p>This community is full of tech writers
I have a lot of respect for, and I'm
keen to hear from each of you - even if
it is just to say "I don't care".</p>
<p>Once we have moved toward "rough
consensus" we can then re-raise the
motion.</p>
<p>For my part, I don't have an opinion
yet; my opinion will be formed based
upon this discussion.<br>
</p>
<div
class="gmail-m_-7690532271233100777gmail-m_7308414463379079456gmail-m_864816695974039353gmail-m_-8434028684073174857moz-cite-prefix">On
8/8/19 5:06 am, Jennifer Rondeau wrote:<br>
</div>
<blockquote type="cite">
<div dir="ltr">Point of clarification:
is this a style guide for the project
to follow as it develops content, or a
style guide to recommend to projects
that might use tGDP?
<div><br>
</div>
<div>The former, I'm somewhat +1 to
MS, somewhat -1 to the Google guide.
Happy to explain if needed.</div>
<div><br>
</div>
<div>The latter, I'm -1 on any style
guide. The appropriate guidance is
the kind of thing that the WTD guide
already provides (lots of options,
with explanations of what they are
and why they might be appropriate
for particular
contexts/requirements/audiences/projects).</div>
</div>
<br>
<div class="gmail_quote">
<div dir="ltr" class="gmail_attr">On
Wed, Aug 7, 2019 at 2:47 PM Clarence
Cromwell <<a
href="mailto:clarencewcromwell@gmail.com"
target="_blank"
moz-do-not-send="true">clarencewcromwell@gmail.com</a>>
wrote:<br>
</div>
<blockquote class="gmail_quote"
style="margin:0px 0px 0px
0.8ex;border-left:1px solid
rgb(204,204,204);padding-left:1ex">
<div dir="auto">That might be a
worthy alternative. Is this a
motion, and if so, what dictionary
would go with it?<br>
<br>
<div
id="gmail-m_-7690532271233100777gmail-m_7308414463379079456gmail-m_864816695974039353gmail-m_-8434028684073174857gmail-m_-3413773148948906288AppleMailSignature"
dir="ltr">Sent from my iPhone</div>
<div dir="ltr"><br>
On Aug 7, 2019, at 11:43 AM,
Stephanie Blotner <<a
href="mailto:sblotner59@gmail.com"
target="_blank"
moz-do-not-send="true">sblotner59@gmail.com</a>>
wrote:<br>
<br>
</div>
<blockquote type="cite">
<div dir="ltr">
<div dir="ltr">What about the
<a
href="https://developers.google.com/style/"
target="_blank"
moz-do-not-send="true">Google
Developer Documentation
Style Guide</a>? </div>
<br>
<div class="gmail_quote">
<div dir="ltr"
class="gmail_attr">On Wed,
Aug 7, 2019 at 9:20 AM
Clarence Cromwell <<a
href="mailto:clarencewcromwell@gmail.com"
target="_blank"
moz-do-not-send="true">clarencewcromwell@gmail.com</a>>
wrote:<br>
</div>
<blockquote
class="gmail_quote"
style="margin:0px 0px 0px
0.8ex;border-left:1px
solid
rgb(204,204,204);padding-left:1ex">
<div dir="ltr">I move that
we adopt the <a
href="https://docs.microsoft.com/en-us/style-guide/welcome/"
target="_blank"
moz-do-not-send="true">Microsoft
Style Guide</a> and
the <a
href="https://www.merriam-webster.com/"
target="_blank"
moz-do-not-send="true">Merriam-Webster
</a>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.
<div><br>
</div>
<div>(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.)<br>
<div><br>
</div>
<div>Reasoning: </div>
<div>
<ul>
<li>We need to all
work from a
single
standard. </li>
<li>These guides
are available
for free
online. </li>
<li>The Microsoft
Guide is
specific to
technical
writing, and is
widely accepted
in the industry.</li>
</ul>
<div>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. </div>
</div>
</div>
</div>
_______________________________________________<br>
SeasonOfDocs mailing list<br>
<a
href="mailto:SeasonOfDocs@lists.osgeo.org"
target="_blank"
moz-do-not-send="true">SeasonOfDocs@lists.osgeo.org</a><br>
<a
href="https://lists.osgeo.org/mailman/listinfo/seasonofdocs"
rel="noreferrer"
target="_blank"
moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/seasonofdocs</a><br>
</blockquote>
</div>
<br clear="all">
<div><br>
</div>
-- <br>
<div dir="ltr"
class="gmail-m_-7690532271233100777gmail-m_7308414463379079456gmail-m_864816695974039353gmail-m_-8434028684073174857gmail-m_-3413773148948906288gmail_signature">
<div dir="ltr">
<div>Stephanie Blotner</div>
<div><br>
</div>
</div>
</div>
</div>
</blockquote>
</div>
_______________________________________________<br>
SeasonOfDocs mailing list<br>
<a
href="mailto:SeasonOfDocs@lists.osgeo.org"
target="_blank"
moz-do-not-send="true">SeasonOfDocs@lists.osgeo.org</a><br>
<a
href="https://lists.osgeo.org/mailman/listinfo/seasonofdocs"
rel="noreferrer" target="_blank"
moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/seasonofdocs</a><br>
</blockquote>
</div>
<br>
<fieldset
class="gmail-m_-7690532271233100777gmail-m_7308414463379079456gmail-m_864816695974039353gmail-m_-8434028684073174857mimeAttachmentHeader"></fieldset>
<pre class="gmail-m_-7690532271233100777gmail-m_7308414463379079456gmail-m_864816695974039353gmail-m_-8434028684073174857moz-quote-pre">_______________________________________________
SeasonOfDocs mailing list
<a class="gmail-m_-7690532271233100777gmail-m_7308414463379079456gmail-m_864816695974039353gmail-m_-8434028684073174857moz-txt-link-abbreviated" href="mailto:SeasonOfDocs@lists.osgeo.org" target="_blank" moz-do-not-send="true">SeasonOfDocs@lists.osgeo.org</a>
<a class="gmail-m_-7690532271233100777gmail-m_7308414463379079456gmail-m_864816695974039353gmail-m_-8434028684073174857moz-txt-link-freetext" href="https://lists.osgeo.org/mailman/listinfo/seasonofdocs" target="_blank" moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/seasonofdocs</a>
</pre>
</blockquote>
<pre class="gmail-m_-7690532271233100777gmail-m_7308414463379079456gmail-m_864816695974039353gmail-m_-8434028684073174857moz-signature" cols="72">--
Cameron Shorter
Technology Demystifier
Open Technologies and Geospatial Consultant
M +61 (0) 419 142 254</pre>
</div>
_______________________________________________<br>
SeasonOfDocs mailing list<br>
<a
href="mailto:SeasonOfDocs@lists.osgeo.org"
target="_blank" moz-do-not-send="true">SeasonOfDocs@lists.osgeo.org</a><br>
<a
href="https://lists.osgeo.org/mailman/listinfo/seasonofdocs"
rel="noreferrer" target="_blank"
moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/seasonofdocs</a><br>
</blockquote>
</div>
</blockquote>
</div>
_______________________________________________<br>
SeasonOfDocs mailing list<br>
<a href="mailto:SeasonOfDocs@lists.osgeo.org"
target="_blank" moz-do-not-send="true">SeasonOfDocs@lists.osgeo.org</a><br>
<a
href="https://lists.osgeo.org/mailman/listinfo/seasonofdocs"
rel="noreferrer" target="_blank"
moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/seasonofdocs</a><br>
</blockquote>
</div>
<br clear="all">
<div><br>
</div>
-- <br>
<div dir="ltr"
class="gmail-m_-7690532271233100777gmail_signature">
<div dir="ltr">
<div>
<div dir="ltr">
<div dir="ltr">
<div dir="ltr">
<div dir="ltr">
<div dir="ltr">
<div>
<div><span style="font-size:12.8px">Cameron
Shorter</span><br>
</div>
<div>Technology Demystifier</div>
<div>Open Technologies and Geospatial
Consultant</div>
<div><br>
</div>
<div>M +61 (0) 419 142 254</div>
<div><br>
</div>
</div>
<div><br>
<br>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
_______________________________________________<br>
SeasonOfDocs mailing list<br>
<a href="mailto:SeasonOfDocs@lists.osgeo.org"
target="_blank" moz-do-not-send="true">SeasonOfDocs@lists.osgeo.org</a><br>
<a
href="https://lists.osgeo.org/mailman/listinfo/seasonofdocs"
rel="noreferrer" target="_blank"
moz-do-not-send="true">https://lists.osgeo.org/mailman/listinfo/seasonofdocs</a><br>
</blockquote>
</div>
</div>
</blockquote>
</div>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<pre class="moz-quote-pre" wrap="">_______________________________________________
SeasonOfDocs mailing list
<a class="moz-txt-link-abbreviated" href="mailto:SeasonOfDocs@lists.osgeo.org">SeasonOfDocs@lists.osgeo.org</a>
<a class="moz-txt-link-freetext" href="https://lists.osgeo.org/mailman/listinfo/seasonofdocs">https://lists.osgeo.org/mailman/listinfo/seasonofdocs</a>
</pre>
</blockquote>
<pre class="moz-signature" cols="72">--
Cameron Shorter
Technology Demystifier
Open Technologies and Geospatial Consultant
M +61 (0) 419 142 254</pre>
</body>
</html>