Technical writing is an often misunderstood (and too-often maligned) field. Those who believe the myths about technical writing may not see its value and therefore miss its bottom-line benefits. Let’s look at those myths and then you decide the truth about technical writing for yourself.
Author: admin
Take a look at this picture of the keyboard on my Dell Studio 1558 laptop (shown above). Notice anything odd?
Well, where’s Number Lock? What happened to the numeric pad (usually shares keys with the 7, 8, 9, U, I, O, J, K, L and M)? These keys are typically used to type alt code combinations for characters not represented in the English keyboard. A Spanish speaker like yours truly would use them to type the letter “ñ”, accented vowels, and the “upside-down” exclamation and question marks.
The first time I tried to use alt codes with the laptop I thought: “I must be missing something. They must have come up with some hip new way to do it.” But how?
It turns out that in their infinite wisdom, computer hardware OEMs have decided to start eliminating features that customers “don’t want” (specifically, the Number Lock and Scroll Lock keys) in order to replace them with things that we just can’t live without, like the Windows key, a disk ejection key, or a right-click menu key. Fortunately, my manufacturer’s support staff offered some ‘helpful’ alternatives like using the Character Map or changing my keyboard language anytime I wish to type a non-standard character. Alternatively, they offered to return my ability to type accented characters in exchange for a ransom payment of $18.99 for a Targus USB numeric pad.
I still haven’t been able to decide if I’m more frustrated by the removal of a feature that I ‘don’t want,’ the support staff’s absurd ‘solutions’ to the problem that the removal of this feature has created, or the manufacturer’s complete lack of awareness of the message that it sends: “typing in any language other than English on your U.S.-market laptop will not be tolerated.”
So let this be a lesson: if you or your employees value the ability to type special characters quickly (whatever the reason may be), make sure you add the Number Lock Key to your list of features to consider for hardware purchases. It doesn’t come standard anymore.
It’s quite often that I’m confronted with one of the most typical questions of today: so what do you do? My reply is that I do marketing for a technical writing company. The inquirer’s response: “cool” or “what is technical writing?” and I’ve never really had a good answer.
Why do companies fail to see the value of documentation? Simple answer: virtually no one reads it. While true, does this mean that the few people who do read it are the only ones who benefit from the information in the documentation? The answer is a resounding No.
I don’t know about you, but I’m constantly Googling anything and everything and I frequently end up on Wikipedia’s website. One day I was looking at all of the possible languages I could read an entry in and noticed “Simple English” was one of the options. I was reading about something complex and “Simple English” simplified the topic and made it easier to understand (you could say it’s a “red carpet” to the “English” entry).
Categories
Documentation yields cost savings
In most companies, documentation is simply a cost center. But did you know that documentation can save you money?
It’s a common misconception that documentation is at best a necessary evil—something that facilitates processes that would already happen. But documentation is more than just a catalyst; it can fundamentally change the way work is done, bringing improvements that cut costs.
This week we had an opportunity to claim some free advertising space in a somewhat non-traditional way, and I’m going to tell you how we did it.
In case you’re not familiar with the term, hotlinking is when a website other than your own uses images that reside on your servers by linking to them directly. Even if you aren’t concerned about protecting the content, this is still a cause for concern since you give up a little bit of your bandwidth (which you paid for) every time the other website loads that image, without getting anything in return. It’s like if your neighbor powered their toaster by running an extension cord to an outlet in your garage – not much impact on your bill if it happens once, but it sure adds up when they do it over and over every single day. (The general consensus on the Internet is that this is a Bad Thing.)
So, you ask… how do I turn this into the free advertising that you speak of?
Categories
RFP Responses Go Technical
With the tightening economy and more competition, more and more companies are relying on the RFP (request for proposal) process to find the best vendors/products. This process often involves a team effort with members of product development, finance, and marketing (to name a few of the most common groups) involved in drafting a response. We’ve worked with several companies recently helping them respond to RFPs and wanted to share our findings on the matter.
When you are a company dealing with your customers’ most valuable personal information, you need them to trust you. One easy way to do this is to have your documentation flawless (or close to it). Also, performing a test run with a small group of people before releasing it to the masses is a good idea. The group of people should be 3rd party users who can find the mistakes you can’t find (since you’ve read and reread the form 40 times and never want to see it again).
Categories
Will work for…work
As “Intern Emily,” I may be a bit biased, but I think that everyone should be using interns. Among the plethora of reasons, here are a few I see: