Categories
Writing service
Essays Tags
Blog > Archive by tag 'technical writing'
-
Published on Thursday, April 8, 2010 by
Varied organizations give rise to in-house tools or reorient commercially-available tools as regards their own use. These tools should get documented so they are of speak to others in the organization.
If this documentation is not created or is poorly written, it costs you twice:
* The earliest cost (attributed to any in queer street user detail) is the expense... Read More »
-
Published on Friday, September 18, 2009 by Essays
Overview
Our humdrum, sterile headings and writing manner do little to encourage our Users to read parts of the product documentation that would be especially beneficial for them. This article presents two real-world examples, how they fail their users, and how to correct the problems.
Not the Legal & Disclaimers
Although the Legal and Disclaimer sections of your d... Read More »
-
Published on Thursday, September 10, 2009 by Essays
I have seen jobs posted for help with term papers. What I mean by "help" is a little more than editing a student's term paper. Specifically, there are college students who are willing to pay hundreds of dollars to have someone else write a paper for them. This practice is nothing new, but it is much more prevalent than many folks realize.
Truthfully, I could probably... Read More »
-
Published on Sunday, May 17, 2009 by Essays
OVERVIEW
You're a non-writer who has just been assigned to write the User Documentation for your company's new product. Your overwhelming emotion is fear, perhaps with some anger.
With any new activity there will be some anxiety. Writing may have added anxiety because of your writing experience while you were a student.
Writing User Documentation is not like the wr... Read More »
-
Published on Friday, April 24, 2009 by Essays
OVERVIEW
Most product documentation sounds like their product is the only thing in the User's life. Such thinking results in User confusion and dissatisfaction. This article presents three real-life examples of this attitude, and what should be done to remedy these unfortunate situations. The article concludes with some techniques for the writer.
BACKGROUND
There a... Read More »
-
Published on Saturday, January 31, 2009 by Essays
OVERVIEW
Searches in User Documents (manuals, etc.) often fail because the Reader uses different words for a concept than the author uses. Since the Reader's words do not appear in the document, the document search mechanism cannot find them, resulting in frustration. This article describes a User-friendly technique for improving searches, without having to change t... Read More »
-
Published on Thursday, December 25, 2008 by Essays
OVERVIEW
Stop confusing your Reader with the words you use. Your Reader is trying his/her best to understand how your product works without having to figure out your writing. Here are some writing guidelines to help you stop baffling your Reader.
SAME CONCEPT: SAME WORDS
User Documents are not meant to be entertaining. Do not try to be creative, especially by using... Read More »
-
Published on Tuesday, November 25, 2008 by Essays
Overview
Incomplete User Documents disappoint your Readers. Two attitudes of many Technical Writers result in incomplete User Documents. These two attitudes are:
. "Everyone Knows That", and
. "The User Can Figure It Out"
This article describes these attitudes and presents methods for overcoming them. The result is more effective User Documents and more satisfied ... Read More »
-
Published on Tuesday, September 16, 2008 by Essays
OVERVIEW
Many organizations produce in-house tools or modify commercially-available tools for their own use. These tools should get documented so they are of use to others in the organization.
If this documentation is not created or is poorly written, it costs you twice:
* The first cost (attributed to any poor user document) is the cost of answering the Users' qu... Read More »
-
Published on Wednesday, June 25, 2008 by Essays
If you have great passion for words and have a degree or diploma in any technology field, then your chances of success is beyond your wildest imaginations. You can be part of that clan of writers out there, who make anything from a thousand dollars to several thousands every month from writing technical articles online for freelance websites, building their brands and... Read More »