Should Technical Writing be Boring? And if Yes, Why?

Should Technical Writing be Boring? YES, TECHNICAL WRITING IS SUPPOSED TO BE BORING. We are bored when there is ZERO VARIANCE. And good technical writing must have zero variance in its description of how-to steps and other components. For example, if we call a procedure “subroutine” on page 2, we have to call the same object…

Read More

7 Personality Characteristics of a Technical Writer

There are 7 Personality Characteristics of a Technical Writer… First off, a tech writer (TW) should be CURIOUS about the world around her. Without that basic curiosity, there is nothing to explain or document. If you are the type of person who used to break toys and open them up to see how they worked…

Read More

Hi-Tech Low-Tech Technical Writing

Introduction There are two types of customers in technical writing – internal customers, and external (or “end-user”) customers. We create our documents and content for these two types of readers/users when we do any technical writing. I just received a letter from a concerned reader who is asking if he can find a job as…

Read More

11 Indispensable Concepts of English Grammar You Should Know

Introduction Nobody’s perfect. Nobody knows ALL the rules and concepts of English grammar. But do you know enough not to raise eyebrows when you open your mouth? Do you know enough of the basic terms and building blocks of English to communicate smoothly with an editor, reader, or another writer? 11 Basic Concepts of English…

Read More

How to Write a Great Overview Sentence for an Ordered List

© Ugur Akinci An ordered list is one with numbers for each entry. In technical or business writing it helps a lot if each numbered/ordered list is prefaced by an OVERVIEW sentence. Such lead sentences prepare the user/reader appropriately for what is to follow. For example, here is a great overview sentence for the list…

Read More
Framemaker numbered list

7 Ways to Overcome Writer’s Block

Here are seven time-proven ways to overcome Writer’s Block. They worked for me in the past. I hope they’ll work for you too in the future. Start from any part of your project you like. You do not need to start writing the “Introduction” or the “Overview” first. Try starting from the middle of your…

Read More

How to Write a Great Topic Sentence for a Paragraph

© Ugur Akinci A TOPIC SENTENCE is the first lead sentence in a paragraph consisting of multiple sentences. The topic sentence summarize the main idea of the paragraph. It sets the expectation about what is to follow in the rest of the paragraph. You can even say it’s a “commercial” so to speak that “sells”…

Read More