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

Eliminate Nominalization from your Technical Writing

  © Ugur Akinci Eliminate nominalization (i.e., turning verbs and adjectives into nouns)  not only from your technical documents but from all your writing. Nominalization is the name grammarians have given to the process by which direct verbs are turned into convoluted phrases by adding suffixes like –tion, –ment, etc. There are other ways (fertile…

Read More
Localization

Localization — Don’t Use Phrasal Verbs in Your Technical Documents

Introduction to Localization Localization of technical documents requires the translation of the technical text into local languages. Some English components do not have corresponding equivalents in other languages and thus are almost impossible to translate correctly. Globalization versus Localization Localization is the process of adapting a product to suit different regional or international markets. It…

Read More

Technical Writing — End Your Sentences with What Matters the Most

© 2010 Ugur Akinci Readers remember what they read the last much better than what they read first. Thus try to end your sentences with things that really matter. Don’t end your sentences with matters of secondary importance. For example, here is a sentence from U.S. OSHA Technical Manual: “Workplace investigations of ventilation systems may…

Read More