When to Use Jargon in a Technical Document?
Introduction As a technical writer you’ve heard this piece of sage writing advice a thousand times: you should stay away from jargon and write as you speak. It’s basic. Strunk & White said so, didn’t they? It’s true. But is this rule true ALL the time, unconditionally? No, I’m afraid it is not. Life has…
Read MoreHow to Set Up a "Media Room" for Your Small Business Web Site
Set up a Media Room (MR) for journalists visiting your Small Business web site. A Media Room will jack up the traffic to your sales, event sign-ups, or membership subscriptions by offering all the necessary easy-to-use copy and photos for the editors and producers who are on a deadline. A journalist or an editor visiting…
Read MoreTechnical Writing – How to Edit a Technical Document?
Imagine you’re a technical writer looking over my shoulder as I’m editing a technical manual. This is how I’d do it: ORIGINAL: “Logging in involves the Operator typing in his User ID and Password.”BETTER: “To log in, the Operator must enter a valid User ID and Password.” ORIGINAL: “The operator’s assigned authorities for operating, configuring…
Read MoreTechnical Writing – How to Use the Bulleted Lists Properly in Your Technical Document
© Ugur Akinci 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. Compare: “In winter months make…
Read More