Violating Document Specs May Cost CA County $548 Million
© Ugur Akinci I forgot the number of times I’ve emphasized the importance of clarity and accuracy in technical documentation in this blog and the dire consequences that can arise from such errors. To my online course students that’s something I make clear right away: a technical document must be correct and accurate above anything…
Read MoreHow to Decide How Granular Your Technical Writing Should Be
How granular and detailed your technical writing should be? This common problem is sometimes also referred to as the “granularity” issue. For example, consider the following alternative description of the same procedure: DESCRIPTION 1 (not so granular): Open First.html in IE9. DESCRIPTION 2 (very granular): In your browser’s URL window, enter the following URL and…
Read MoreWatch Your Misplaced Modifiers — Importance of Positioning in English Sentences
Just like in life, positioning is important in writing as well. Place the wrong modifier in the wrong spot, and the meaning of your whole sentence changes and you end up creating the wrong impression for no good reason at all. Sometimes even professional writers writing for important publications fall into this trap. Here is…
Read MoreMS Word VBA — How to Write Macros, Procedures, Functions
© Ugur Akinci Very simply put, you can use MS Word VBA to write macros, which are nothing but automated action steps running one after the other at the click of your mouse or when you select the macro from the menu bar. Macros save us time. Instead of selecting three or four items in…
Read More