Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Commit

Permalink
Ensure references to style guides are consistent
Browse files Browse the repository at this point in the history
  • Loading branch information
Alyssa Rock authored and Cameron Shorter committed Feb 28, 2021
1 parent 88ef4c3 commit 0573114
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
16 changes: 8 additions & 8 deletions style-guide/about-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ that all of the contributors are working from the same common understanding.

A project's style guide usually starts out as a stub at the beginning of a
project. For example, it might simply indicate which style guide is your
project's default guide, such as the Google Developer's style guide or the
Microsoft Manual of Style. It might link to specific elements from the default
project's default guide, such as the Google developer documentation style guide
or the Microsoft Style Guide. It might link to specific elements from the default
guide that are most relevant to your project or point out any exceptions to the
default guide.

Expand Down Expand Up @@ -81,10 +81,10 @@ documentation.

Maintenance of a style guide is a lot of work. Try to do as little of it as
possible by deferring to a more comprehensive default guide, such as the Google
Developer's Style Guide or the Microsoft Manual of Style. In this section,
you should indicate which guide is your default guide and reference the source
document and its version. Document any exceptions where your style guide differs
from your default guide.
developer documentation style guide or the Microsoft Style Guide. In this
section, you should indicate which guide is your default guide and reference the
source document and its version. Document any exceptions where your style guide
differs from your default guide.

Also, if your project already has existing brand guidelines, you can link to
them or include them here.
Expand All @@ -101,8 +101,8 @@ inherit or defer to term definitions from a more authoritative glossary source.

This section includes a table to highlight terms that are unique to your project,
or which conflict with your default style guide. For example, the Google
Developer's Guide uses "open source" but our project prefers "open-source" when
used as an adjective, as in "open-source software."
developer documentation guide uses "open source" but our project prefers
"open-source" when used as an adjective, as in "open-source software."

## About the "Topic types and templates" section

Expand Down
4 changes: 2 additions & 2 deletions style-guide/template-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ forum posts, and so forth.}
## Our preferred style guide

We have adopted the
{[your preferred style guide, such as the Google developer's style guide](https://developers.google.com/style)}
{[your preferred style guide, such as the Google developer documentation style guide](https://developers.google.com/style)}
for {Your Project} documentation. For a quick summary, see the
[Google style guide highlights](https://developers.google.com/style/highlights).
The rest of this document describes our project-specific customizations to
Expand Down Expand Up @@ -97,7 +97,7 @@ sensitive to differences and seeks to promote equal opportunities.

For resources on making your writing more inclusive, see:

- [Inclusive documentation - Google developer's style guide](https://developers.google.com/style/inclusive-documentation)
- [Inclusive documentation - Google developer documentation style guide](https://developers.google.com/style/inclusive-documentation)
- [The Conscious Style Guide - a collection of resources](https://consciousstyleguide.com/)
- [Bias-free communication - Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/bias-free-communication)
- [Guidelines for Inclusive Language - Linguistic Society of America](https://www.linguisticsociety.org/resource/guidelines-inclusive-language)
Expand Down

0 comments on commit 0573114

Please sign in to comment.