Articles>Writing>Style Guides

What’s More Important, Content or Process?

While style guidelines can be useful for maintaining consistency across a set (or several sets) of documentation, the editors that I worked with viewed the style guidelines as sacrosanct. Any deviation, no matter how small, was punishable by a nasty email and a sharply worded note to the offending writer’s manager.

Sometimes, You've Got to Break the Rules

Sometimes, you don’t need documentation made up of perfectly-chosen words and phrases. Instead, you need something that can be easily scanned, easily understood, and easily digested. Documentation that distills the main points quickly.

Writing Great Documentation: Technical Style

Now that I’ve discussed what kinds of technical documentation to write, I can move on to the question of how to actually develop a writing style that produces great technical documentation. So how do you learn to write (anything) well? There’s only one answer: you’ll learn to write well if you write. A lot.

Style Manuals: The Politics of Selection

Bette Frick and Betsy Frick discuss how a style manual can save time and money, how to select the proper style manual and get buy-in, and how to create a style guide to use in conjunction with a style manual.

Do I Really Need a Style Guide?

Style guides recommend certain styles. In the domain of technical communication, we refer to guides for writing style, presentation of content in user documentation and technical documents, and graphical user interface of software and web sites.

The Missing Manual Authors’ Guide

This Authors’ Guide tells you everything you need to know to write Missing Manual. It starts out by giving you a brief introduction to the Missing Manual way of explaining things and then takes you through the nitty gritty of style guidelines, figure formatting, and so on.

Do I Really Need a Style Guide?

So, after all, I must follow those infernal style guides. I am straight-jacketed. Am I not?

How to Use the Bulleted Lists Properly in Your Technical Document?

Bulleted lists are important in technical writing. They summarize information in a manner that is easy to read and absorb. Use them whenever you can to get your information across quickly. Bullets are ideal for things-to-do, equipment, sets, collections, cooking ingredients, and all kinds of other lists.

One Space Or Two Spaces?

When I began writing technical documentation and courseware for Guru Labs, I asked a question during training about whether we should be putting two spaces after a period, colon, question mark and exclamation point, or one. The answer shocked me, as I was hoping for the standard answer as a means of teaching the rest of my colleagues. The answer was ONE space, not two. Then, I listened to the argument.

Style Guides? Dictionaries? Who Cares?

You should! Whether you're a corporate or a freelance communicator, a style guide and a dictionary are among your most important tools. And all the departments in your company or your client's company should be using the same ones, designated by their communication departments.

Intelligent Terminology Management

Using multiple terms to refer to the same concepts can be a major cause of confusion. Ray explains how to implement a process to consolidate the terminology used by your organization.

Social Rules for Creating a Style Guide

Creating a style guide may initially seem like a terminology affair ('option button' or 'radio button' - pick one), but the real challenge lies in persuading the department to adopt new style principles. Some writers will feel threatened by change, and respond in bizarre and unpredictable ways. Whisper campaigns and ambushes may lie in wait for you. Beware, innovative editor! Before you even think about the literary details of style, prepare to do battle with the true Goliaths and Grendyls: the department itself. By following these five rules below, you can avoid an unexpected apocalypse when you reveal the new guide.

Keep Spelling Consistent With a Style Sheet

Consistent spelling and punctuation increases your website's credibility. Often it's your decision: 'inhouse' or 'in-house', for instance? Either one is correct, but you must use the same punctuation throughout.

Standards for Online Content Authors

The standards on this page include non-technical standards relevant to all web authors and technical standards relevant to some web authors.

Microsoft Manual of Style for Technical Publications

Microsoft is one of the largest software companies in the world. Thus, with their rich experience in documentation it is only natural that they share it with the rest of the IT industry. The Microsoft Manual of Style for Technical Publications, Third Edition (MSTP) is the latest step in this direction and takes care of latest technologies and technical terms.

Five FAQs About Business Writing

A few style guide tips for novice business writers.

Necessary Transition

As writers and editors, we understand instinctively that readers need transitions, but we also work at getting rid of unnecessary words.

Verbs with -ize: Efficient or to Be ... Ostracized?

A discussion of whether neologisms such as 'prioritize' have 'arrived' yet.

Do Technical Writers Need an International Standard for English-Language Spelling?

He demonstrates how ministers of state who speak different languages often choose English as the most convenient language of communication. He cites the 11-nation European Central Bank in Frankfurt as a typical organization that works only in English. And he notes that many of the journals published by respected international organizations such as the Pasteur Institute also are published in English. TC-Forum is another example.

Writing Processes

Our Writing Guides help you locate information quickly on specific topics. These guides focus on a range of composing processes as well as issues related to the situations in which writers find themselves.

Terminology and Spelling for Web-Related Concepts

Generally speaking, 'Web' as a short form of 'World Wide Web' is capitalized, with one exception (webmaster). However, your company style may prefer the lower-case version.

Use of Hyphens

This page collects a series of notes from readers of my newsletter, and my responses to those notes, arising from an article in issue 60, 13 May 2002. I thank those who took the time to write and explain why some hyphen usage is considered to be correct or incorrect.

Choosing the Right Style Manual(s)

Editors should consider at least four points in selecting, or reevaluating, primary and secondary manuals.

Look at Common Style Differences in Choosing Manuals

Style manuals often differ on important points, and one way to choose a manual is to compare them on some of those points.

Appearing for Sentence

Commas, semi-colons and colons are the sentence tidiers. Used correctly, they'll give your written language the 'punctuation' that pauses, voice modulations and gestures provide when you speak.

Are We Agreed?

'Agreement' refers to elements in a sentence having the same number, gender, case or person. In English, it's probably an issue only for number (that is, singular vs plural) and case (that is, 'I' vs 'me', 'he' vs 'him' and so on).

Capital Punishment

Many documents suffer from over-capitalisation. The writer sprinkles capitals everywhere in an attempt to make words stand out - with the result that nothing stands out. Here are some simple rules to help you avoid this capital offence.

Caught in the Active

Have you been told, perhaps by your computerised grammar checker, that too many of your sentences are passive? Have you heard the rule of thumb that at least 80 percent of the sentences in any passage should be active? If you've had the problem or heard the rule, and wonder what the terms active and passive mean, and why one is good and the other frowned on, this article is for you.

The Elusive Apostrophe

Like teenagers and salespeople, apostrophes are frequently there when they're not wanted, and not to be seen when they're needed.

Gender-Neutral Language

One of the most significant changes taking place in English is the rejection of the way that 'man' was assumed to include 'woman'. Most of us want our writing to be friendly and inclusive. How can we avoid using 'man', 'he', and 'his'?

Making Sense

When we are trying to communicate complicated ideas, it is important to be specific. One way to ensure that you will not be misunderstood is to look at your use of 'scope'. 'Scope' refers to which words go with which to form a 'sense unit' in a sentence; for example, which nouns are covered by a particular verb or preposition. Often, poor punctuation or poor sentence construction messes the scope up. Scope isn't easy to explain, but you can get a handle on it once you have seen a few examples of how it works.

Muddled Sentences

Misplaced modifiers are usually obvious and easily fixed.

Reported Speech: a Tense Issue

The tense of the verb in a statement is, as a general rule, shifted back in time in reported speech.

Sentenced to a Cruel End

A simple definition of a sentence is: a set of words that expresses a complete thought and contains a subject and a predicate. Let's look at this.

Using 'Which' and 'That'

'That' clauses form a sense unit with the word they're attached to, and that's why they aren't preceded by a comma.

Communicating in Spite of TLAs (Three-Letter Acronyms)

The unchecked use of acronyms and initialisms in technical writing presents a huge obstacle to clarity and readability. Although technical communicators are certainly more aware of this problem than are the engineers, scientists, and managers with whom they work, they need concrete guidelines and at least a small degree of self-righteousness on this subject to help them cope with the onslaught. That acronyms frustrate communication is well-founded in linguistic theory and common sense. Suggestions for mitigating their effect include issues of audience, term selectivity, frequency and occasion of use, and aesthetics.

The Reference Book That Editorial Eye Built

About three years ago we were asked whether we would be interested in writing a new and different kind of style manual: * In addition to covering all the traditional style topics, such as capitalization and punctuation, it would have chapters on grammar, confusable words, usage (including bias-free language), and all aspects of production, from design and typography to desktop publishing and printing. * Its audience would be the vast majority of working writers and editors, not just those who work with scholarly manuscripts. * It would be written and organized in a friendly, easy-to-read style and reflect the impact of the computer on every aspect of the publishing process. Although we were a bit cowed at the thought of tackling such a big project -- it turned out to be 836 pages -- we didn't see how we could turn down the chance to create a guide that was truly useful.

When Technical Writers Don't Write Technically

Technical writers are often asked to write more than just end-user manuals or online help systems. Due to company size, layoffs, or a lack of resources, the technical writer might also be expected to deliver marketing communication collateral, Web site content, training materials, and more. These additional tasks can daunt those who have not been formally trained in other writing styles or those who do not switch writing styles easily.

The Most Obvious Fault in Technical Writing

The most obvious fault is wordiness. Fortunately, long-windedness is something that editors are particularly well equipped to fix. Take a look at our manuals. They are huge, and their very bulk can make them inaccessible, especially when they are not equipped with a good index or adequate indicia in the corners of each page.

The Style Guide is 'Dead': Long Live the Dynamic Style Guide!

Nobody, least of all an editor like me, would argue that printed style guides are really dead--at least not in the sense that they're no longer with us and no longer useful. Yet there's no doubt that printed style guides are looking a little antequated these days. Despite how useful the guides are to writers and editors, they're simply too static for most writers, and don't take advantage of computer technology to make the writer's working life easier. But if you're thinking that online style guides are inherently better solutions, think again; using the computer to find static information certainly helps, but simply moving a paper guide online only exchanges one form of 'static' for another.

Writing Consistently Across Media: Ten Proofreading Tips

Last time I wrote about consistency in online writing. Soon after, I received an email from Leslie Drechsler, a reader in Tustin, CA: 'As a Marketing Communications Specialist, I'd love to hear your ideas on how to successfully implement consistency in an established business,' she wrote. 'I thought developing a company style guide would solve the problem. But perhaps there are other ways to approach it. 'Perhaps this could be the subject of another article.' Here's that article, Leslie.

Frequently Asked Questions About English

Asterisks.com answers some frequently asked questions about English usage.

Style Sheets: The Abbreviated Answer

As a project moves from writer to editor to designer and ack again, style sheets (abbreviated versions of style gides) offer quick access to answers during documentation development. Style sheets provide consistency, give a quick-reference point, set a project’s style from the beginning, eliminate confusion on major style points, and serve as a double check during revision. Designed specifically for a project, style sheet formats include laminated sheets and standees, and content ranges from grammar references to contact information.

Technical Writing Rules You Didn't Learn in RHET 101

To hyphenate or not to hyphenate, that is the question. As compound nouns evolve over time in Eng- lish, they gradually move from being written 'open' (data base) to being hyphenated (data-base) to being written 'closed' (database). Just where your particular word might be in its evolution is often un- clear and subject to the inscrutable and highly individual logic of copy editors. Consult a recent edition of a standard dictionary.

Understanding the Importance of Style Guides

Style guides describe conventions for virtually every aspect of writing, ranging from such things as spelling, punctuation, and word usage, to structural and formatting issues. With the myriad of style guides in use, the dilemma for many writers is deciding which one to learn and apply in the trade. The answer to this is easy: learn at least one style guide thoroughly and keep a selected few others for backup. In the course of recruiting technical and generalist writers and editors for nearly a decade, I am sometimes shocked at the low level of familiarity with long-established style guides by people who claim to be seasoned professionals in this business. The reality is that it is plainly obvious to spot writers who “claim” to know a style guide and those who have actually taken the time to study it. The proof is in the pudding, as they say. The quality and consistency of a writer’s or editor’s output is the litmus test to how proficient he or she is in applying a given style guide.

The Style Guide is Dead: Long Live the Dynamic Style Guide

Arguing that printed style guides are too static to be useful, Hart recommends using a dynamic style guide, a system of templates, macros, and reference materials that actually guides writers through their work. The article also advocates direct interaction between editors and writers as a non-technical approach to a dynamic style.

The Passive In Technical and Scientific Writing

Almost every discussion of technical or scientific style mentions the passive voice, usually as a stylistic evil to avoid. While I doubt that many of us would endorse such extreme prescriptions as 'Always use the active voice,' or 'A writer will almost automatically improve his style when he shifts from passive to active constructions,' we may be more ready to accept Freedman's position in 'The Seven Sins of Technical Writing.' His Sin 6 is 'the Deadly Passive, or, better, deadening passive; it takes the life out of writing, making everything impersonal, eternal, remote and dead,'3 but he adds that 'frequently, of course, the passive is not a sin and not deadly, for there simply is no active agent and the material must be put impersonally.'

The Rhetoric of the Paragraph: A Reconsideration

Efforts to define the fundamental structures that enable meaning in discourse have a long history, beginning with ancient speculation. Classical logic, rhetoric, and grammar imposed restrictions on the processes of composing, as well as the shapes of finished texts, in order to safeguard the truth by attending to prerequisites for its effective communication. From earliest times, a concern for vindicating some larger moral order, and for teaching others to appreciate it, has often motivated pronouncements on the nature of verbal form. From Quintilian to the present, for example, teacher-scholars have striven to insure that logical and aesthetic values celebrated in the classical doctrine of decorum are made suitably manifest in student performance, as though to enforce publicly accepted styles of thought and action by reference to acceptable forms of language.

Grammar, Punctuation, Spelling

The Web abounds with sites teaching grammar, punctuation, and spelling. Not surprisingly, most of these sites are provided by educational institutions, teachers, or business-writing consultants, presumably to make up for the lack of grammar teaching in so many school systems for the past several decades. Some are tutorials (masquerading as style guides) for technical communicators. Here are a few sites that I have found useful or that other people have recommended to me.

Gender-Neutral Technical Writing

Gender-neutral writing uses language that does not stereotype either sex nor appear to be referring to only one sex when that is not the writer's intention. In this article, you'll see why gender-neutral writing is important for technical writers to use, what gender-neutral writing is not, and how you can use gender-neutral writing in the documents you develop.

Editing for Gender Neutrality

How to be politically correct without mangling the English language. The goal is that the reader should not notice the writing.