Skip to content

Details

One quality in documentation that most technical writers appreciate is consistency. Writing that is consistent is easier to navigate and understand. A consistent company voice makes a good impression on users. And it’s aesthetically pleasing. Style guides are the internal documentation that help us create consistent external documentation. Let’s discuss this common tool of the trade.

  • What problems have you solved with a style guide?
  • What problems has a style guide created for you?
  • What industry style guides have you used in your career?
  • Which ones do you particularly like or dislike? Why?
  • What about in-house style guides, ones that are specific to your company?
  • Have you ever led an effort to create an in-house style guide? What was that like?
  • Have you seen style guides that didn’t work? What went wrong?
  • Have you seen style guides that were very effective? What contributed to their success?
  • What are the things you think are most important to include in a style guide for technical documentation? What do you think should be left out?

Our Code of Conduct applies to all our community spaces.

We'll use Zoom for this meetup. Register to receive the Zoom link here in the event description. Then, when you log in to Zoom for the event, be sure that your Zoom name matches the name you used in your registration.

Want to get notifications about our events? You’ll find instructions in the “About” section of the home page for this meetup.

You may also like