The Discipline of Punctuation in Technical Writing

© Ugur Akinci Today let’s talk about the discipline of punctuation Technical writing is nothing if it’s not about discipline, precision and consistency. That’s how tech writers impose order on disorder. One of the most basic we impose that order on an otherwise unruly collection of information is the application of stringent punctuation rules. When…

Read More

Survey: British Office Workers Hate Business Speak

If you’re miffed to hear hackneyed expressions like “think outside the box” you’re not alone: a lot of office workers in Britain reported they also can’t stand the expression, according to a British survey of 2,000 cubicle dwellers. Tweny five percent of those surveyed ranked “blue sky thinking” and “hit the ground running” as number…

Read More

The Difference a Comma Makes

© Ugur Akinci Technical writers must watch their punctuation like a hawk because of the dramatic difference a misplaced punctuation mark makes. Here is a great example from the Understanding Uncertainty web site: “how unlikely the result is due to chance” versus “how unlikely the result is, due to chance” Click here to read the…

Read More

The Politics of Plain English vs. Obfuscation

Usually people don’t write in plain English because they don’t know any better. Sometimes a banker, an engineer, a doctor will write a business letter or a technical document in a way that he or she best knows how – by using jargon and long-winded sentences; clauses awash in passive voice and unparallel construction, with…

Read More

President Obama Signed Plain Writing Act of 2010

  © Ugur Akinci A new era has begun in the United States when President Obama signed the Plain Writing Act of 2010 on October 13, 2010. According to this, all U.S. government agencies and offices are now mandated to create all their documents and communications in clear, uncomplicated English. Here is the text of…

Read More

How to Avoid Dangling Participles in Your Technical Writing

© Ugur Akinci “Dangling Participles” is the kind of writing error you should avoid in your technical documents because it changes the meaning of a sentence and often leads to unintended humor. But first — what is a “participle”? PARTICIPLE is the present- or past-participle form of a verb which is used as an ADJECTIVE.…

Read More

4 Levels of Editing in Technical Writing

Writing is re-writing; that is, editing. Technical editing is a crucial part of all technical writing projects. But we have to remember there are multiple levels of technical editing which makes the task all the more challenging. LEVEL 1 EDITING Spec Editing. Does the document satisfy all the macro requirements specified in the Documentation Plan?…

Read More