Proposal Writing for U.S. Government Contracts

“Proposal Planning and Writing for RFPs” is a 51-page (8.5” x 11”) comprehensive volume describing in over 10,000 words every aspect of responding to a government RFP (Request For Proposal). This e-book even covers the questions that need to be asked to decide whether an RFP is the correct one, way before the prosal writers…

Read More

Mini-TOC in Adobe FrameMaker – A Life Saver!

One of my most favorite features is mini-TOC which I know I’ll be using during my daily work. I’m grateful for it. No one has any idea about the untold hours I’ve spent in the past constructing this chapter-specific mini-TOCs. Such mini-TOCs are a must when you have chapters in a book as long as…

Read More
FrameMaker template

Basic Software Documentation Terms Every Tech Writer Should Know

Introduction It helps to know Basic Software Documentation Terms if you’re documenting any software product. It cuts down on your preparation time and saves you from getting those “funny stares” from the developers/engineers when it becomes apparent that you don’t know what you’re talking about. Rule of Thumb Always do your homework first and get…

Read More

How to Write Goal-Focused and Structured Technical Documents

PREMISE Most of the technical documentation that exists in the world today is feature-focused. It is also unstructured: there is no well-defined hierarchy between the components of the document. For example, there is no enforcement of a hierarchical rule like “every task description shall be followed by a reference section.” See this related article. PROBLEM…

Read More

Avoid “Double Possibility” in Your Statements

When copywriting, avoid double possibility in your statements. That’s the fundamental rock on which all copywriting stands. George Bernard Shaw once wrote a very long letter to a friend and ended it with the following post script: “Sorry, I didn’t have the time today to write you a short letter.” Clean technical writing is easy…

Read More

Construct Sentences that Do Not Require Mental Inversion

© Ugur Akinci When we construct a procedural sentence in technical writing we are usually telling the reader either to do something or not to do it. Our intention is either pointing out to something positive or negative. For easier comprehension and longer retention, try to construct your sentences in a way such that the…

Read More

Job Prospects in Technical Writing vs. Copy Writing

An accountant/bookkeeper reader asked whether copy writing is a better alternative in terms of finding jobs than technical writing, especially in rural areas. The following was my answer to him: “I’d say the chances of finding a tech writing vs. copy writing job in rural areas is just about the same. The business that has…

Read More

Send Surveys to Improve Your Documents

A common problem we technical writers have is our lack of contact with the end-users. If you are like me working for a large corporation, the end-users are handled by the marketing and sales department, plus, the field reps and tech reps. They usually do not want you as a tech writer to get in…

Read More