The 4th edition of the Microsoft Manual of Style (MMoS) has been updated substantially in a few crucial areas. It’s indispensable, if you work in a Microsoft domain and worth checking out if not.
Full disclosure: I’ve received a free review copy.
The previous edition of 2004 was becoming quite dated, so a new edition was eagerly awaited by many writers. Here’s what’s new, so you can make up your mind whether you need the new edition. I’ll focus on the first half, the “General Topics” with guidelines, which has the most significant updates.
Guidelines have been reshuffled to emphasize the book’s shift from technical publications (such as online help or user manuals) to professional technical communications (which may also appear in web sites, blogs or wikis):
- Previously, the first two chapters were dedicated to “Documenting the User Interface” with screens, dialogs, properties, etc. and to layout. So the message was: “Put proper words pretty on a page.”
- Now it’s the “Microsoft style and voice”, followed by “Content for the Web”. So the new message is: “Know your audience and adapt your sound and your channel!”
Many guidelines and examples have been carried over or edited only slightly from the previous edition, which is fine, because they still apply.
Examples have adopted a new tone: Previously, they were marked as “Correct” or “Incorrect”, now they’re labelled “Microsoft style” or “Not Microsoft style”. Ironically, this modesty is undercut by another change in the text. Previous suggestions to “avoid” certain things have become more strict and now tell you “do not use”.
Layout feels fresher throughout and easier to read. See for yourself at amazon’s Look inside preview.
The 4th edition by chapters
Ch. 1: Microsoft style and voice
A front-loaded new section presents 9 pages of “Principles of Microsoft style” along the lines of consistency, attitude, language, precision, sentence structure and grammatical choices, punctuation, contractions, and colloquialisms and idioms.
This is a welcome framework that can double as a declaration of values or truths to be held self-evident. A tech writing team I know uses the MMoS as the background for their in-house style guide – and with this new section, I guess they can get rid of some of the painfully argued standards and simply refer to this new edition.
I see this section not as a dictate by Microsoft, but as a modest proposal that’s worth considering – and discarding only with good reason. The book’s Look inside at amazon.com allows you to preview most of the chapter, so check it out to see what I’m talking about.
Ch. 2: Content for the web
This important chapter has also been rewritten and moved to the front where it has the prominent position it deserves. But to be honest, it trails several more focused, more expert works.
Still, this is now much more oriented towards useful content and starts with “Make the right content choices” and then goes on to advocate scannable, organized text with lots of links. Additional, but short sections address video, blogs, and wikis as well as task analysis, SEO and social media optimization.
So it’s now a decent attempt with helpful suggestions in the context of a style guide. If you’re at all serious about writing for an audience on the web, you will know or want some of the more expert titles.
Ch. 3: Content for a worldwide audience
This chapter has been edited and expanded, but not substantially changed from the previous chapter 3 “Global Content”. You can preview it, along with the new 2-column layout of guidelines and more information, as a sample chapter at Microsoft Press’ blog post.
Ch. 4: Accessible content
As the audience of technical communications has grown and diversified, accessibility has rightfully gained traction. So it’s a pity to see that this important topic still only gets 4 pages, and not much that’s new to boot.
This is little more than a first check list to make you aware of essential issues and remedies. You can find more in-depth information online.
Ch. 5: The user interface
This is the centerpiece of the manual – and essentially the law in what user interface stuff is called in the Microsoft universe. It’s where the new edition excels and the previous edition was most badly dated.
Much of this chapter had to be redone completely to include ribbons, smart phones, the MS Office 2010 “backstage view” (which is what the File menu section is now called that has replaced the application button). If you’re writing for any Microsoft product, including Windows, you will need this sooner or later.
Ch. 6: Procedures and technical content
This chapter has also been updated:
- Cloud computing is in.
- Guidelines for procedures, reference, XML and HTML documentation remain.
- Standards on documenting COM and ActiveX are out.
Ch. 7: Practical issues of style
This chapter now combines parts of what used to be chapters on “Content Formatting and Layout” and “Common Style Problems”. It contains essentially unchanged information about cross references, dates, numbers, page layout, titles & headings, etc.
Ch. 8: Grammar
A welcome addition to this chapter are several “international considerations”! If you’re writing for translation or an international audience, you’ll find these tips helpful, such as:
- Avoid passive, because it translates poorly into some languages.
- Avoid imperative in marketing tag lines which comes across as dictatorial in some cultures.
- Avoid “(s)” for optional plural which translates poorly.
There have been few changes or updates to the remaining chapters on Punctuation, Indexes and keywords, and Acronyms and other abbreviations.
The Microsoft Manual of Styles is a very helpful resource. It’s mainly well thought out and solves many problems, so you don’t have to.
If you write for Microsoft environments at all, you need this latest edition to stay consistent.
If you write for the web, accessibility, localization, international audiences, API/SDK documentation, you may need additional resources, either as online or print resources. The MMoS won’t – and in all fairness: can’t – deliver everything you need.
Filed under: books, style guides | 14 Comments »