The IBM style guide
by Francis DeRespinis · first published 2011
2mentions
1recommended by
2HN commenters
2017–2018first – last mentioned
50% recommend50% neutral
Affiliate links. As an Amazon Associate I earn from qualifying purchases.
While there are many excellent style guides out there, I personally went with the IBM Style Guide: Conventions for Writers and Editors [0] when I started writing technical manuals and documentation. It is so comprehensive that the book ends up describing itself exactly, as if it were some kind of…
on “Writing Documentation When You Aren't a Technical Writer” ↗…is an amazing content strategist). They have to be. For context, I'm an alumni of the Red Hat content team, which I joined from a corporate background and was frustrated to see the team relied on the IBM Style Guide. I pushed for Red Hat to make a canonical open source style guide, as I researched common patterns across engineering and tech writing that can create disparity in UIs or APIs if one group ends up writing…
on “Red Hat Writing Style Guide” ↗