Skip to content

Commit

Permalink
for Wisdom's Sept 9 hour on style guides, originally maintained on my…
Browse files Browse the repository at this point in the history
… GitHub
  • Loading branch information
Barrie committed Sep 2, 2022
1 parent 8d8ed18 commit 28622cc
Showing 1 changed file with 100 additions and 0 deletions.
100 changes: 100 additions & 0 deletions content/post/style-guide-collection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# Style guides

Submitted by <https://github.com/barriebyron> for the September 2022 mentoring program hosted by Wisdom.

I’m a word nerd and I love style guides. Learn more about me <https://linktr.ee/barriebyron>.

In my daily work as a technical communicator, I don't have to remember everything. Instead, I just remember where to look for the answers to my many questions. I rely on trusted style guides.

I bookmark frequently visited pages in style guides on my web browser at work. I compiled this easy-to-share list of style guides so that we can all benefit. Feel free to share. Style matters.

## What is a style guide?

A style guide contains a set of standards for writing and designing content. It helps maintain a consistent style, voice, and tone across your technical content. Style guides contain usage rules, best practices, punctuation guidelines, text formatting guidance, and more.

## Why use a style guide?

A canonical set of guidelines to create clear, concise, and consistent technical content for the intended audience.

## More resources

For more style guide resources, see the Write the Docs Learning Resources Documentation Guide [Style Guides](https://www.writethedocs.org/guide/writing/style-guides/).

**Tip:** Write the Docs is a global community of people who care about documentation. We consider everyone who cares about communication, documentation, and their users to be a member of our community, [join us](https://www.writethedocs.org) to learn more.

## Technical content style guides

I collect style guides for reference, inspiration, and models of how organizations share decisions about style. I maintain this working collection of links to online style guides.

- [Google developer documentation style guide](https://developers.google.com/style) my daily go-to reference

- [Google developer documentation API reference](https://developers.google.com/style/api-reference-comments)

- [Apple Style Guide](https://help.apple.com/applestyleguide/)
[DigitalOcean Product Documentation Style Guide](https://www.digitalocean.com/docs/style/)

- [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/)

- [GitLab Docs Documentation Style Guide](https://docs.gitlab.com/ee/development/contributing/style_guides.html)

- [MongoDB Documentation Style Guide](https://www.mongodb.com/docs/meta/style-guide/)

- [Red Hat Technical Writing Style Guide](https://stylepedia.net/style/)

- [Rackspace Style Guide for Technical Content](https://docs.rackspace.com/docs/style-guide/)

- [Splunk Style Guide](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Howtouse)

- [1Password Style Guide](https://support.1password.com/style-guide/)

## Bonus resources

- [Style Guides: What Goes In Them and What Can They Cover?](https://www.single-sourcing.com/events/using-style-guides-to-achieve-content-collaboration-and-consistency/) from my friend Liz Fraley at Single Sourcing Solutions

- [The Diversity Style Guide](https://www.diversitystyleguide.com) helps media professionals write with accuracy and authority

- [Sum of Us A Progressive’s Style Guide Theory of language for change](https://s3.amazonaws.com/s3.sumofus.org/images/SUMOFUS_PROGRESSIVE-STYLEGUIDE.pdf)

- [Alex](https://github.com/get-alex/alex/blob/main/readme.md) a tool to catch insensitive, inconsiderate writing

- [Guide: Inclusive Language and Vocabulary for Startups and Tech](https://buffer.com/resources/inclusive-language-tech/) from Buffer social media tool for authentic engagement

## Other handy style guides

- [Federal plain language guidelines](https://plainlanguage.gov/guidelines/) (USA)

- [Australian Government Style Manual](https://www.stylemanual.gov.au)

- [IEEE Editorial Style Manual for Authors](http://journals.ieeeauthorcenter.ieee.org/wp-content/uploads/sites/7/IEEE-Editorial-Style-Manual-for-Authors.pdf) (2022)

- [Online Writing Lab (OWL)](https://owl.purdue.edu/owl/purdue_owl.html) at Purdue University writing resources, instructional material
OWL parademic method clean up wordiness in writing

- [University of Oxford Style Guide](https://www.ox.ac.uk/sites/files/oxford/media_wysiwyg/University%20of%20Oxford%20Style%20Guide.pdf) (2014)

## Learning technical writing resources

- [The Good Docs Project](https://thegooddocsproject.dev) templates to make good docs

- Google [Technical Writing Courses for Engineers](https://developers.google.com/tech-writing)

- GitLab [Technical Writing Fundamentals](https://about.gitlab.com/handbook/engineering/ux/technical-writing/fundamentals/)

- Write the Docs [Learning Resources](https://www.writethedocs.org/about/learning-resources/) extensive collection, multiple formats

Do you have other style guides and awesome resources to share? Let me know. Reach out on [LinkedIn](https://www.linkedin.com/in/barriebyron/) or email <[email protected]>.

## Helpful grammar resources

I use [Grammarly](https://app.grammarly.com/) premium. I find it especially helpful with complex sentences written for complicated subjects.

## User assistance design guides

- [Atlassian Design System](https://atlassian.design/content)

- [Sky UX Design](
https://developer.blackbaud.com/skyux/design/guidelines/user-assistance)

- [Eclipse User assistance support](https://rtist.hcldoc.com/help/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Fguide%2Fua.htm)

- [GitHub Primer Design System](https://styleguide.github.com/)

0 comments on commit 28622cc

Please sign in to comment.