technical writer_2"technical writer" How much can a technical writer make if he or she is very good at it?
And what areas are the most lucrative? Or what other well paid jobs could a skilled technical writer do?
I know a couple of technical writers. Their earnings are similar to those of teachers in public schools. They make a living, but they're not at the higher end of the middle class. My understanding is that steady work for a company which produces a wide array of products, and therefore needs tech writers all the time, is preferable to the piecework approach where smaller companies hire tech writers for more money--but there are long gaps without work.
The skill set involves more than being able to write clearly and tersely, with no ambiguity. It involves quick comprehension of whatever technology you're writing about, too, otherwise any English major could do it.
I would consider majoring in whatever technology science most interests you, and minoring in English.
New Technical Writer: Use the Persona to Create the Most Useful Section of your User Document
OVERVIEW
A good User Document includes sections on how to set up, use, and care for the product. However, to create a great User Document , the technical writer should use the Persona, generated in the analysis of the User/Reader, to create the topics for the most useful section of the User Document. This article describes this procedure.
THE MOST USEFUL SECTION OF A USER DOCUMENT
The most useful section of a User Document is the one that helps the User get what he/she wants/needs done right now!
Writing such a section might seem to be an impossibility. How do you know what the User needs to do now?
The only thing that you, as a writer, can do is to play the odds. That is, determine the topics that have the highest probability of being of interest to your User. And "of interest" means "getting what the User wants done, right now."
We created Persona (an almost-real representation of your product's User) in another article in the "New Technical Writer" series (see the links in the "Resources" or "Author Information" section of this article). We can use the Persona to create a topic list for this section.
USING YOUR PERSONA
This step in using your Persona is missed by almost all User Documents that I have seen. Yet this step will result in a User Document that is most satisfying to your Reader. Here it is:
Imagine your Persona using your product. Now, what are the main things that your Persona will want to do with your product.
As an example we will use a photo editing program (Acme FotoPhixer, a hypothetical product from a hypothetical company) that comes bundled with a point and shoot digital camera. Our Persona is a typical user of such a camera.
Ask: What does that Persona want to do with Acme FotoPhixer?
The short answer is that they want to improve their photos. HOW can they improve their photos with Acme FotoPhixer? In OUR words (not the words of the User) we could tell them how to:
* Rotate
* Crop
* Red-eye removal
* Adjust brightness & contrast
* Removing unwanted items from the photo
* Focus/Blur
* Save
* Print
* Share
These names are what we, the photography experts might use. However, "crop" may be meaningless to our Persona. In fact, we could move crop into "Removing unwanted items from the photo."
The "Focus/Blur" topic is interesting. If a photo is out of focus or blurred, there is really nothing that our software can do to improve it. However our Reader does not know this, but still wants to do it. We should include topic with this text: "It is impossible to fix the focus or remove blurring in a photograph. You might be able to improve this using the [Sharpen Effect] tool in FotoPhixer." (The [] specifies a reference to the topic in the User Document.)
DON'T HIDE THIS SECTION
If your Reader cannot quickly find what he/she wants to do in your User Document, then the document has failed. Since we created this section to answer the User's pressing needs for the product, then we must make this section very accessible to the User -- they have to be able to find it easily.
"Fixing (Improving) Your Picture" is a PERFECT, User-oriented title. That is the correct title for this section. Don't bury this gold under titles such as: "Tutorial" or "Use FotoPhixer's Tools." These titles do not suggest answers to the User's questions.
You should make this section very easy to find in the User Document. It's the key section of the User Document. It has the information that most Readers want, most of the time (by your analysis). Place it prominently in the User Document.
SATISFYING THE READER IS EASIER THAN YOU THINK
Producing this section is easier than you think.
First, imagine that you were NOT going to include this section. Your User Document would still have to cover all of the features, tools, and user interactions for the product. You need to do that to satisfy your boss. It's also logical. If a feature is not described, then why is it in the product?
Thus you have created a topic list for a "classical" User Document.
Now we create our User-oriented section, "Fixing Your Picture." Here are the steps:
1. List each of the topics for fixing a picture, using titles that the Reader will understand.
2. Provide a brief overview, perhaps with a picture showing before and after the use of this fixing method.
3. Then list the steps for that topic, and provide links to the documentation for the relevant tools for each step
Done!
Actually, I would recommend using what I call a "Visual Index," which is described in the links in the "Resources" or "Author Information" section of this article.
Within Document Re-usability
We could call this organization method "within document re-usability." Here the writing for a topic exists as an item in the "reference" section of the User Document. By referring to that item when it is needed for performing a User-oriented task, we make the text do double duty. This results in reusability within the document.
HOW TO GET THE TIME TO WRITE THIS SECTION
Put less detailed effort into the documentation for the product's features that will be rarely used. For example, FotoPhixer includes tools to make the image look like it's made of stone, or produce 3D effects, etc. These are rarely used, and have a similar set of controls. Instead of detailing the use of each of these rarely used features, write a global usage, describe the controls, encourage the User to experiment, and remind them of the un-do and cancel capabilities.
You can create the "most useful" section with the time you save by not thoroughly documenting these rarely-used items.
THE BOTTOM LINE
You can make your User Document much more effective if you think about your User/Reader and what he/she wants to do with the product. Use this information to create an easy to find section in your User Document that meets your Reader's needs.
About the Author
Barry Millman, Ph.D., has a Bachelor of Science in Electrical Engineering (1966, Carnegie Institute of Technology) and an M.Sc. and Ph.D. in Psychology (Human Information Processing, University of Calgary). He has been a consultant for over 25 years, an instructor, course developer, and award-winning speaker. For the past seven years he has been researching and creating resources to help organizations create great User Documents.
Visit: http://www.greatuserdocs.com/ for resources to help you create the User Documents that your Product needs and your Users deserve.
Visit http://www.greatuserdocs.com/ReadingRoom.htm for more articles like this one.
The calls usually begin with an apologetic "never needed a programmer resume" admission: "I've never had to urge a skilled resume before." Or, "I never dreamed of hiring a skilled resume writer. I've invariably been in a position to land a programming job." Or, "I never even had to look for jobs. They found me."
Software wizards have seldom needed help from resume wizards. Programmers have a desired set of skills that has usually created it easier for them to seek out a job than several others. Not like the rest of us, several programmers have seldom had to pay much time developing their technical software engineering resume. The thought of hiring a resume writing professional never entered their minds, until the recent economic crisis.
When it comes to a programmer's resume and cover letter, the standard advice applies: Highlight accomplishments, write clearly, design the document rigorously, avoid spelling errors, organize the resume in reverse chronological order unless you have a compelling reason to arrange it functionally. List your technical skills, making sure you cover the skills that are most in demand nowadays.
However there are more special job search tips for software programmers/engineers. Sharpen your skills also your resume. If you have got key skills that are in demand, then today will be just like those good recent days. Firms are trying for specific skill sets: For instance, accomplishments and expertise in the world of hard core algorithms, pattern recognition, statistics, and applying algorithms to planet data. If you've got these skills you're doubtless to possess a smart chance to seek out an opportunity. You may even realize you will get multiple offers.
You would like to create this tough core algorithmic experience clear on your resume. Not all skilled resume writers are qualified to handle technical resumes. Build sure you ask regarding their experience in the technology field. Creating technical accomplishments clear and to the purpose requires special expertise.
Other timely skills you do not need to leave out embrace: AJAX/JavaScript, Objective C, Java, PHP or Ruby on Rails.
If you lack these skills and if you're having a powerful time finding a job, you should start studying. Realize a good book that can facilitate your build these skills and begin putting them to work. Contemplate getting concerned in an open source project; or start collaborating in some discussion groups that permit you to let others grasp that you are enhancing your skills.
Sharpening specific talent sets is a good plan, in fact. If you'll be able to seem like a drawback solver to companies that are trying to figure out how to handle the tons of information they face, then you'll be an appealing candidate. Businesses do not recognize how to investigate knowledge well. Things like laptop vision, data mining, collaborative filtering, machine learning, video processing: Of these specialties can be hot for many years at least. Enhance your skills. Learn the vocabulary. Determine recent innovations and the businesses associated with them.
Managers hiring programmers are impressed if you have contributed to open source projects. If you are a Java programmer and participated in an open supply Java project then you have an advantage over other job candidates. Another approach is to create your own open supply project. It will cause individuals to pay attention to you because not everybody does this and it demonstrates a certain special interest and keenness for the field.
It's a good plan for programmers to possess a website. But, build positive it is a clean, well-designed website. Again, the writing should be crisp. Likewise, some managers can take a look at the HTML code on your site thus build positive you've got clean code. Place your resume on your website. Make sure it's cleanly coded. Not simply a converted Word file.
Also, show off a number of your code from a project on your website. Managers appreciate the chance to review some sample code.
Use the networks: Facebook and Linkedin, for example. Create positive you have endorsements on LinkedIn. Work your LinkedIn networks. Participate in groups that share your interests. You'll notice people these teams are at companies that are hiring.
If you are curious about mobile computing, design an iPhone application. Get it reviewed. Get individuals talking concerning it. Facet comes like this are effective techniques to induce noticed.
This could appear like a heap to try and do however the good news is that these job-search ways together with a professional resume <http://www.ShimmeringResumes.com> work and in today's economy effective job-search methods are the envy of many.
About the Author
Writers Room has been writing articles online for nearly 2 years now. Not only does this author specialize in Job Search Techniques, you can also check out his latest website about:
