Using Style Guides to Achieve Content Collaboration and Consistency

Style Guides: What Goes In Them and What Can They Cover?

Style guides serve an important role, establishing guidelines to improve communication, ensure consistency, and enforce best practices in composition, presentation, and language, and representing the specific needs of the business and it’s customers.

Most organizations adopt one of the major manuals of style (like the Chicago Manual of Style or the Microsoft Manual of Style) and develop an internal “house style” that further defines the voice, tone, and vocabulary.

We find style guides everywhere–in stand-alone documents, application templates, in stylesheets–and we find more when we move out of desktop publishing into automated publishing systems.

In this session, you’ll learn how style guides can help with collaboration and improve consistency. I’ll describe the different kinds of style guides, what each contains, and when you need them. We’ll talk about the different kinds of style guides and what each one covers. We’ll normalize some vocabulary so you will always know what someone else means.

About Liz Fraley

Liz Fraley, CEO of Single-Sourcing Solutions, is well known for her advocacy of defining requirements. She has founded two companies, sits on the boards of three non-profits, and is constantly coming up with new ways to share knowledge in the technical communications and content industries. She has worked in high-tech and government sectors, at companies of all different sizes (from startups to huge enterprises). She advocates approaches that directly improve organizational efficiency, productivity, and interoperability. If you ask her, she’ll say she’s happiest when those around her are successful. Her first book, “Arbortext 101: Best Practices for Configuring, Authoring, Styling, and Publishing with Arbortext,” is available on Amazon. She has several more planned.

Watch the Video

Recorded: 9 September 2019

View the Slides

References

Our Favorite Links related to style guides in one handy PDF: bit.ly/s3i-styleguide-resources

Style guides from around the web:

Sum of Us Progressive Style Guide
https://s3.amazonaws.com/s3.sumofus.org/images/SUMOFUS_PROGRESSIVE-STYLEGUIDE.pdf
Purdue University’s Online Writing Lab (includes: APA, AMA, MLA, CMOS)
https://owl.purdue.edu/owl/purdue_owl.html
Microsoft Style Guide
https://docs.microsoft.com/en-us/style-guide/welcome/
IBM Editorial Style Guide
Online: https://www.ibm.com/developerworks/library/styleguidelines/index.html
Amazon: https://amzn.to/2LiqjTa
55th edition of the official Associated Press Stylebook (2020)
Amazon: https://amzn.to/36HqGxp
Mailchimp’s style guide (for internal and customer writers)
https://styleguide.mailchimp.com
Amazon Product Page Style Guides
https://sellercentral.amazon.com/gp/help/external/G200270100

DITA:

DITA Best Practices: A Roadmap for Writing, Editing, and Architecting in DITA (Laura Bellamy, et. al.)
http://bellamy.tcdojo.org
Practical DITA (Julio Vazquez)
http://julio.tcdojo.org
The DITA Style Guide (Tony Self)
https://amzn.to/2DJaiiA