I love the Willcopy Proofreading and Grammar blog. Great helpful examples.
Category: Tech Writing
-
OpenOffice v. MS Word
Bruce Byfield writes an article about Breaking the Word Processor Curve which compares Open Office and MS Office from an expert’s point of view. (Thanks, Jenny).
-
Tech Writing Blogs?
While searching the web for technical writer resources, I realized that there aren’t any big technical writing blogs. Maybe it’s because tech writers are more inclined to blog about video games or Asian art than their profession. Where do you go for blogging about technical writing? First there is elearningpost which is more about e-learning than tech writing per se, but writing issues come up often. Also, Boxes and Arrows cover information architecture and interface design, which often relates to technical writing. So far, the best tech writing weblog is Jenny L. Berger’s CreativeTechWriter weblog and webword. For humor, you can read Lies that are Told to Technical Writers (somewhat reminiscient of a Dilbert column I read once) and Klingon Technical Writers. Also, Michael Knowles does a terrific weekly newsletter about technical writing issues, and his website contains archives of his articles.
-
Resumes Part II: This Resume is Terrible!
The woman looked at resumes mainly to find a person’s job history, so she wanted a “job obituary” format. For a recruiter, it is much more convenient to favor candidates with experience most resembling that of the current assignment. It is much easier to reduce a candidate to simply the sum of his/her previous jobs.
This is a good resume, but it is good in only two contexts. First, when opened as an email attachment, the resolution onscreen is almost perfect, and even the “job section” stares the reader directly in the face. Second, while this resume might not be liked by HR and recruiters, I think that techies would love it. It provides much more information than the typical resume and arranges the skills by function. For a “database admin” job, the first thing an HR person would look for is previous experience under the “Jobs” section. But the technical manager might be more interested in knowing the kinds of databases a person has worked with, and what sort of administrative tasks that the person has performed. So the tech manager would want to find experience by function rather than by job.
There are two intended types of readers for this resume, and both read the resume in almost opposing ways. The HR scans the resume; the hiring manager looks a little more closely. The question boils down to how to make a resume that satisfies both the scanner and the person willing to spend more than 10 seconds looking at it?
This is a question frequently raised in usability and discussed by Alan Cooper in his book “About Face: The Essentials of User Interface Design” Different users have different goals, and it is sometimes impossible for a design to accommodate more than one persona at once. One solution might be to provide levels of customization on a website according to a user’s specific goals. Or a website could have some parts which are “high resolution” (to use Edward Tufte’s phrase) and some parts which are “low resolution.” Maybe a button can allow the user to switch between two views: general and detailed.
For the resume, one answer might be to “lighten up” the resume and include more in the cover letter. Another solution might be for the “lite resume” to include “url’s” for further information.
One problem the woman had was that my resume subverted her expectations about where information ought to be. Because the format was unconventional and she’d never encountered it before, she was momentarily flustered. On the other hand, if half of all resumes looked like this, it would probably not bother her at all. I still feel that the original resume organized job information in a superior way. But that does not change the fact that the resume scanner would have to read this one a little differently, a little more carefully.
As a website gains in functionality and content, there may be a need to redesign the GUI entirely. This may not be an easy task to do, especially if one is dealing with static pages that are not stored in a database. But there is another more subtle problem: will the user accept the change as good? Even if the redesign were better, it is not clear whether users will perceive it or so. Print media likes to redesign in one fell swoop without telling anyone. But that strategy might not work for websites. Instead, incremental changes to the GUI might allow users to continue to use their stored knowledge of how to use the website. Maybe the GUI changes can be deployed so slowly that no one ever notices the changes.
-
Edward Tufte, Resumes and 5 Years Experience
In my previous post, I discussed the excellent ideas from the world?s leading expert on interfaces and design, Edward Tufte. Tufte encourages designers to maximize the use of space as a general rule. The problem is that white space can reduce clutter and highlight certain information on the screen or page. It also can present a hierarchy in which the information exists. Sometimes there might be good reasons for limiting the view of the data (as Tufte attests in his Challenger example). Let?s use the resume as an example.
Employers usually want a one page resume for ease of scanning, but in today?s technical world, it is practically impossible to convey a person?s full technical skills without an additional page or significantly reducing the font or margins. So is two pages better? An interviewer is extremely unlikely to flip from page to page during an interview. So is smaller font better? A resume does not present simple biographical information. Instead, it presents how the job seeker organizes his career and goals. By definition, a resume is selective. It is not to the job-seeker?s advantage to present information in the typical ?job obituary? fashion. For one thing, if the employer can easily count the amount of time at a job, that gives a quantifiable basis for comparing this candidate with others. That is precisely what job seekers wish to prevent the employer from doing, especially when a job seeker?s proficiencies are gained on projects not directly related to his primary job function. On the other hand, if a resume contains chronological gaps or no dates at all, that also puts up a red flag. Therefore, the ideal resume should contain chronological information without a chronological organization.
Before, the resume writer?s trick was trying to figure out how to condense your basic information into a single page. Now, just putting a url on a resume can allow employers to view as many pages as you want (That can be a dangerous thing of course).
?Must have 5 years experience minimum.? I?ve seen such phrases on 90% of the job ads, but I?ve been unable to figure out what it means. Consider the possibilities:
5 years experience with the same job title? That is a sign the employer is not looking for competence, but stability and aversion to risk.
5 years in the same field? So does time in school count? How about times when you were unemployed and working on portfolios/personal projects?
5 years experiencing using the tool, (programming language, platform)? First, no sane individual uses a single tool for every task on the job, and an individual who does so tends to view business problems in a reductionist way. A person with 5 years experience using Robohelp tends to view every problem as a Robohelp problem. Second, anyone who uses a product for that long a time could be using an out-of-date version. Or they can be in the habit of using high-priced commercial tools instead of free open source tools.
Having the technical competence of a typical person with 5 years experience? If that?s the case, then what about the person with 6 months experience who can do pretty cool things? What about someone with 5 years experience using a different tool but minimally competent on this one? At some point you are concerned more with an individual?s potential to do good work than what he has done (and that is good, isn?t it?)
I?ve always felt that the hardest job skills could be learned by the right person in 2 years or less. So, by demanding 5 years experience, you run the risk of hiring someone purely on the basis of the historical accident of whether they’ve worked at a company using a commercial tool. Employers would like to think that skills can be assessed simply by number of years at the post. They’d like to think that most people can obtain the jobs they are suited for, and that job titles are relatively uniform across the industry. But job titles (especially in technical fields) can be misleading. Requiring “5 years experience” may simply result in weeding out the younger candidates most in touch with new ways of doing things. In the writing profession, proficiency and even ability increases with age. As a 36 year old, I?ve been writing seriously since my senior year at college (when I was 22). That?s 14 years of experience. But on a writing project, a talented writer with three years of experience could have probably done just as good a job.
What alternative do I suggest? Employers should focus on skills necessary for the job, not simply seniority. By “skills,” I mean general skills, not simply familiarity with proprietary applications. If you limit your pool of applicants only to those whose previous employer used a particular application, you are reducing your pool of applicants (and probably having to pay high prices for it too). Oracle is completely different from SQL Server, but a person who worked as a database administrator on one of them could probably pick up the other in no time at all. The same is true for programming. I won’t deny that programming is hard, and that the good programmer is ten times more productive than the mediocre programmer. But a good programmer is not necessary the one who can program in the most languages. Once you learn basic concepts very well, the choice of tool, platform or programming language is almost irrelevant. Therefore, employers should write job descriptions that allow for a diversity of backgrounds rather than insisting on a specific job title or familiarity with a specific tool. Every job description ad should include three parts: Requirements, Highly Recommended and Nice to Have. In some areas (like management), seniority does indicate a level of experience working with different types of human interactions. But in technological fields, seniority is mostly irrelevant. After all, napster was started by someone under the age of 20 and the world’s first graphical browser was written by someone still in college.
Another way to tackle the skills problem is to look at an ability to complete projects or master new challenges. Accomplishments and innovation should be more important than number of years with a job title. True, a person with 5 years experience at a job may face many challenges that make him/her a better worker. But a person without the job title may have faced similiar challenges in different professional contexts. By allowing the second kind of applicant into the job pool, you are making it easier to find the best candidate at the lowest possible price.
-
How Long Should a Consumer Wait on Hold for Technical Support?
A friend of mine regularly calls me up to ask tech support questions about commercial applications. While I generally have no problem about helping him (I’ve pestered enough of my own geek friends at one time or another), I’ve frequently advised him to call technical support of the company supporting the application. That is after all what you pay for when you bought the product. Those people have the best knowledge for solving your problem quickly. No matter how brilliant your friends are, a dimwit technical support guy can probably solve the problem faster.
My friend had complained about Roxio tech support, and I dismissed it. I had lots of experience waiting on hold for tech support. I spent a good three days on hold with ATI about my video card. Actually, ATI is not a bad company, and their tech support was pretty good (if you could reach them). The problem turned out to have nothing to do with ATI and everything to do with quirks of Windows Me.
But nothing can compare to the hell I experienced in calling Roxio, the maker of Easy CD Creator Platinum 5.0. I called up, had to input something called a TSID number. Later, after 10-15 minutes of waiting, an operator came on to tell me that my TSID number was wrong. After keying in my registration and serial number, the operator concluded that the number typed on my box was a misprint. She gave me a new number entirely and put me into the tech support queue.
So I waited. And waited. After 30-35 minutes of additional waiting, the phone system hung up on me. Just like that! I called again, and after about 50 minutes of waiting, the Roxio telephone tech support system hung up on me again!! I know it couldn’t have been me; I was on speakerphone the whole time and couldn’t have accidentally hung up.
At that point I just decided that getting help wasn’t worth it. I sent a demand via email for a product refund. Roxio had already proved itself unreliable at answering support calls.
Just two weeks ago I raved about how Roxio’s site documentation was. And even now, I agree that it is wonderful. It is a model of what a site should be, and indeed while waiting, I browsed through the knowledge database, downloaded upgrades and drivers for my hardware. But it did not solve my problem and I still needed tech support.
It makes sense for companies to spend lavishly on documentation if it results in fewer technical support calls. But it seemed to me that Roxio seemed to have documented an awful lot of technical support issues for their software. Perhaps not only has Roxio skimped on tech support, but also testing as well. The irony is that the software itself looks very impressive from a usability point of view. I might have endured a long wait on telephone support if I could feel confident that someone would get on the line.
Companies seem to have the perception that people overuse tech support, that they do so only because they are too lazy to read the documentation or troubleshoot by themselves. Actually, there is nothing LESS that consumers would rather do than to call technical support. Believe me when I say that if we are calling tech support, we are probably very frustrated and even a bit angry. We have already read the documentation and tried everything we know of to fix the problem.
That is why it was so surprising that Roxio’s telephone system should be so unreliable. To turn your Customer Relations Management to an automated telephone system, you need to be 100% confident that it will not lose calls. A system that fails to do this is by definition not a system that can be used.
It’s funny how small irrelevant details like this can torpedo customer satisfaction. I once bought a refurbished computer from Dell (yes, the company where I worked!) and was dismayed to find that my computer delivery was delayed a week and a half because the person taking the phone order forgot to read me an oral agreement over the phone. The rep had just finished asking me 100 other questions and had been entering them into a database. The order system asked me about my income, my college education and my hobbies, but it never bothered to ask me to okay a verbal agreement which determined whether the sale went through. Completing this step seemed so vital to me that I would have thought that the rep’s computer terminal would have big flashing lights go off when this step was overlooked. (I ended up cancelling the order and building my own computer from generic parts).
The Roxio incident indicates the dangers of cutting costs too much. Roxio had the most expensive burning product on the market for $90, but its tech support staff was still woefully understaffed. How hard would it have been to raise the sticker price 5 or 10 dollars for better telephone tech support? Instead, Roxio seemed to be hoping that the fraction of consumers needing tech support would not overshadow the majority of consumers who were generally happy with the product out of the box. On that matter they were 100% wrong.
Finally, I need to mention getting answers from newsgroups. I used this option often when needing answers to linux questions. For these questions, one usually has lower expectations and a patience for getting the answer. I usually give 48 hours for a decent newsgroup response. If software vendors don’t provide timely support, what advantage do they have against open source software?
-
Documentation = Sales
The need for good software documentation is obvious for people using the product. But its value is less clear for prospective buyers. Many websites maintain a wall between marketing/sales information and user documentation (which falls under the rubric of “support”). The marketing people don?t want consumers to see all the bugs and functionality problems with their software, wanting to put their best foot forward. The support people are just the opposite. They want everybody to be forewarned about limitations and issues related to a product.
For me access to documentation is often a primary determinant of whether I decide to buy a product. Recently I tried to buy some cd-burning software. I had read about 5 or 6 packages in Smart Computing. The market leader, Roxio’ss Easy CD Creator received good marks, but it was also the most expensive product and I?m sure others would serve my purposes. My main need was support for long file names and possibly a good backup program bundled along with it. I looked around a few websites and couldn’t find information worth a damn on these subjects on any site except Roxio (which had a great table about file names). And then, although I thought that my CD burner would probably be supported by most of the programs, only Roxio stated so explicitly. That was certainly comforting. While browsing through the system requirements, I also found 2 or 3 updates or alerts about potential problems to avoid before installing the product.
I was blown away. And when I bought the product at the nearby store, I was pleased to find a nice booklet in the box. Techie types forget that online help serves a marketing purpose by making potential buyers aware of features and support. I cannot stress that enough. One of the most time-consuming parts of system administration is figuring out whether the manufacturer supports your existing hardware or software. Indeed, when I built a system last summer, I spent about 80% of the total time just researching specs. Companies that make serious efforts to systematically organize their online documentation soon find that consumers tend to prefer their products over the competition, simply because they can tell at a glance whether their product is supported. .
Here is my list of some great and awful sites in terms of technical documentation.
Good
- Epson they organize drivers, documentation and manuals in an easy to find fashion. Here is the page for my printer looks like.
- Macromedia their help site has an excellent fusetalk forum for posing user problems. That way, you are not relying solely on support people to answer your problems.
- VMWARE I ended up not buying their product, but generally their how-to’s and online help make it clear what the software can do
- Yahoo okay, online services differs greatly from shrinkwrapped software, but I’ve always been amazed at how tightly it integrated help into the online services.
- Microsoft (Consolation Prize) It’s only natural that the largest software system should have a decent help system. (although I rarely consult it for pre-purchase information, only technical support). Their knowledge base is pretty elaborate, but of course it assumes you need to know what you’re looking for.
Worst
- Norton Antivirus I have flailed about for many hours trying to figure things out, even to figure out about OS support. It’s next to impossible. Go here for Norton “search-engine hell.”
- Partition Magic although the user guide is good, the online help is terrible, and it’s often hard to find out about support.
- Adobe Besides using small fonts, lots of distracting graphics and inadequate manuals, their online forums are often hard to wade through. I spent a good hour just trying to figure out whether 6.-0 Adobe Framemaker is supported in Windows ME. (It’s not).