By Theresa Pojuner on December 20, 2013
User manuals provide a road map for the user. Many technical writers embed screen shots or images into documents to aid the user in seeing what a product or application is composed of, how a task is achieved, and most importantly, what not to do. But there are always questions as to where and how […]
By Theresa Pojuner on November 26, 2013
Use cases and workflow diagrams are two essential practices or methodologies that will effectively demonstrate a functionality of a product. To understand their value, they have to be defined. Use cases are a way to show how a user, consumer, or customer can utilize, or operate a product or application. It systematically details the reason for […]
By Theresa Pojuner on September 8, 2013
Not knowing your audience and stakeholders – not knowing your audience could mean not only presenting unnecessary and non-essential information, but possibly also presenting it in a manner that the audience does not understand. If a document presents unfamiliar or foreign terms to the audience, then the material is not helpful nor constructive. Ignoring your […]
By Theresa Pojuner on March 18, 2013
If you are a beginning Technical Writer or an experienced Technical Writer, how do you, respectively, display your skills and find your first job or find more jobs in technical writing? Here are some tips: For beginners, write about your job – begin writing in your current job about all that you know, and make […]
By Theresa Pojuner on September 3, 2012
One of the most essential components of a document is charts. As Technical Writers, we always write concisely, and clearly, but there will be times, when we need the assistance of charts to communicate what was written. Whether it’s for qualitative or quantitative explanations we sometimes need charts to truly present the whole picture. There […]
By Theresa Pojuner on August 18, 2012
As a Technical Writer, we cannot forget about writing for the Call Center teams who have to answer to clients, buyers, or users of a product or application. They have to be patient, understanding, knowledgeable, and diplomatic. To assist them, the Technical Writer has to be able to create the materials needed by them. Training […]
By Theresa Pojuner on July 9, 2012
Templates are extremely useful for saving time and providing consistency. They are short cuts to formatting and completing your document quickly and easily. They are short cuts because you no longer have to think about how the material should be set up or what style to use for particular types of documents. Having templates not […]
By Theresa Pojuner on May 14, 2012
One of the most difficult things to do is to describe to someone how to put something together or how to operate a device. How do you communicate to someone the procedure to put parts together to build a plane, boat, or car? Or how do you put the pieces of a table or chair […]
By Theresa Pojuner on January 9, 2012
I’ve come up with the following tips to follow when creating a document. You can think of it as a checklist. Hope you find it helpful. Know your SME (Subject Matter Expert) – find them and collaborate; create relationships and work with them and inform them of why you’re there; use any opportunity to gather […]