Manage-It-Write: Miriam’s Documentation and Technical Writing Blog

Miriam's blog

Happy (Jewish) New Year

Wishing you and your family a happy, healthy and sweet new year. We'll be back next week with our top 10 Technical Writing New Year's Resolutions. Here's a sneak peak:

10. Lose at least 5 pounds (from any printed books still in circulation). Trust us, your customers will thank you.

 

Managing Vacation

So my vacation could have gone one of two ways: I could have spent 3 weeks in Southern California with my family sans cellphone and with intermittent email access and hated it, or I could have done it and loved every minute of it. I chose the latter.

For years now, my motto has been “work hard, play harder.” I am the first to admit that I don’t do it enough, but the truth is that all of us need to. Whether it is practicing an instrument, getting up at 5 AM for an early-morning run, twirling your kids around the living room to lively music before dinner or sitting near a fountain at your favorite park or outdoor mall and tuning the world out for 15 minutes while you catch some Vitamin D, I am convinced that the world would be a much happier and more fulfilling and productive place if we all spent a little bit more time doing the little things we enjoy.

I admit to having been that boss (before I had kids) who didn’t understand people’s innate need to take a great family vacation at least once a year and disappear for a solid week or two. I would always take a day off here and there and that would be enough for me. This summer’s adventure was our first family vacation (where I didn’t really work) in 10 years! Nightly family dinners are great, but a family vacation can be your recharge station away from the crazy world around us.

I am not a phone maniac anyway and don’t ever plan to have “Blackberry thumb,” but the past 3 weeks gave me perspective, rejuvenated my work drive and renewed my resolve for the things I love to do and those that I don’t (but that I must do anyway).

Top 10 Things NOT to Say Before or During Summer Vacation

For the next three weeks, I am going on vacation with my family. I’ll be checking my email and working part of the time, but I hope to spend the majority of my days with my kids and my extended family. My trusty assistant will make sure that all of our customers’ and writers’ phone calls are answered and that any documentation emergencies will be taken care of in my absence.

I’ve tried to take a handful of vacations throughout the years, most of which end up with me working full-time but from a remote location. This year, I’m really hoping that our excursion will be more vacation and less work than in the past. And wiith that in mind, I present you with the start of my Top 10 list of what NOT to say to me (or anyone, for that matter) before or during summer vacation:

Soapbox Opportunity

People often email me privately with comments and ideas for my blog. I thought it would be great to have all of those ideas in one place and invite you to give your two cents in an open and public forum. So I open the floor for you, my readers, to tell me what you like to hear more about…more management? More writing tips? Author-it updates? I’ll do my best to keep your suggestions in mind when planning future blog posts. Feel free to post as many or as few suggestions as you’d like. I look forward to hearing your ideas!

The Power of Peers

This week, Tech-Tav sponsored our largest Israeli Author-it Users Group meeting to date. The day before the meeting, registration was complete, food was ordered, presentations tweaked and the supplies were packed up and ready to go. More than 50 technical writers from cities around the country were all coming to hear about upcoming product features and news from the latest build that I was to be presenting.

But the small tickle in my throat that I had been trying to ignore grew noticeably more irritating and my fever spiked. A rapid strep test confirmed that I was indeed infected with strep throat, was contagious and would be in no condition to get out of bed in less than 24 hours, let alone travel and give my presentation.

From a management perspective, it was really, really difficult to make the decision to be absent from my own event rather than cancel it. But because I have confidence in my employees and a network of peers that I know well, I was confident that people would teach and learn from one another. At 10PM, I was able to turn over the reins at a moment’s notice so that the show could go on.

We sponsor these free meetings because, in my opinion, better informed and trained writers benefit everyone: the writers themselves, their customers/employers and the end users who read our documentation. And that just makes good sense for our profession as a whole and for our business. Even though the agenda had to be shifted around and new presentations added at the very last minute, I was hopeful that the peer learning and sharing that was bound to take place would be of great value.

It Pays to Outsource (Part 3)

It has been a super-busy week for new contracts, new writers, placements and deadlines (not to mention the summer camp that is currently taking place in my house, but that’s another whole story). So you’ll please forgive me for not posting this sooner. And now, without further delay, welcome to Part 3 on why it pays to outsource.

In Part 2, I made the following claim: “Outsourcers appreciate the flexibility that their work provides, and they don’t expect the usual perks of full-time employees such as lunch, travel or paid leave.”

A member of my Documentation and Technical Writing Management group on LinkedIn commented in response, “…outsourcing doesn't make the burden of ‘perks’ vanish, though it might seem that way. The burden is simply transferred to a vendor, who, in turn, will surely factor the perks into the billing rate.” 

Kumar, I would suggest that if you are paying the same or more for your outsourcer as you would for an in-house writer of the same caliber, then it’s time to start looking for a new outsourcing company. In Israel, where most of our writers are located, employers pay a base salary plus an additional 37% for social benefits. Without going into all the math, it should suffice to say that my hourly rate doesn’t even come close.

It Pays to Outsource (Part 2)

I didn’t mention it last time, but this is going to be a three-part-series. I already covered some of the great reasons to outsource your technical writing in my previous post, mainly focusing on how the peak-and-valley nature of the workflow in hi-tech lends itself to outsourcing. Now let’s talk agility and experience.

Picture it, if you will…a lone technical writer (or even a team), full-time, in-house. Spending 188 hours a month sitting at the same desk, working with the same SMEs and managers, documenting the same technology. Day after day, year in and year out. Yawn.

From the perspective of the employee (as the commenters from last week pointed out), the benefits of outsourcing are many:  flexible schedule, pick and choose your projects, be your own boss, gain exposure to a wide array of new technologies, writers, writing and management styles…the list goes on and on. Looking at things from the employers side, the view is just as attractive.

Outsourcing your technical writing means more to you as a manager than just “pay your technical writer for the hours she works and not one minute more.” You also get the added benefit of a writer who, by the nature of her work as an outsourcer, is constantly exposed to a wide variety of new and changing technologies, management styles, applications, authoring environments and fresh ideas. During your downtime, the outsouced writer can easily work for 5 or 10 other customers in the course of a year. She brings back to you a breadth of experience that simply could not be gained by sitting in the same company at the same desk year-round.

It Pays to Outsource

A startup in the midst of their initial product development cycle was trying to decide between hiring a full-time technical writer or outsourcing the work on their datasheet and user guide. They were the perfect candidate for outsourcing:  the budget was tight, the work would not be steady over the long term and there was not a single native English speaker on the team to do QA or document review. Nevertheless, and against my advice, they hired a newbie full-time, in-house writer, Bill, because they really thought it would save them money. Bill called me after four months, bored out of his mind, unsure what to do next and looking for project work on the side to fill in the hours and to learn more since he was fresh out of a course. What was happening here? While the startup initially had enough work for a full-time writer, the peak and valley nature of the release cycle meant that:

  • The company was paying Bill a full-time salary for doing part-time work.
  • The company didn’t benefit from someone with experience and know-how in modern documentation technologies or strategies. They took someone cheap, and with little experience who still needed an additional mentor.
  • Bill went from being overworked and underpaid to being bored and underutilized.The usability and purpose of their documentation was never really well developed and Bill didn’t know how to make himself useful to other departments.
  • Bill left within 6 months to find a job where he could hone his skills and learn more. The company had to start knowledge transfer and the documentation process all over again.

Total cost:  Double the cost of the same work via a reputable outsourcing company

Management Top Ten

Here are my top ten eleven management DO’s and DON'Ts. Let's start with the DOs:

1. Do keep in mind the old Yiddish proverb “Man plans, God laughs.” But you had better plan anyway. And make sure you have a contingency plan so the joke won’t be on you.

2. Do your homework, make offsite backups and don’t procrastinate…and then you won’t need to call us for help at 3AM from India because your laptop got stolen and you have no files for your customer delivery tomorrow. (Yeah, you. You know who you are.)

3. Do follow the rules of my first grade teacher:  Finish what you start and ask for help when you need it.

4. Do step up to the plate. In a place where there are no men, be the man (or woman). But whatever you do, check your attitude at the door and don’t let your ego get carried away.

5. Do put the Green Jello Theory into practice:  Make everyone an owner, not just a participant.

And now for the DON'Ts...

6. Don’t make promises you can’t keep. 

7. Don’t make people work on the weekends. Five-day work weeks make for happier employees.

8. Don’t try something new on opening night. When I was in drama club, the rule was “Be on time, know your lines, and don’t bump into the furniture.” The time to deploy a single-sourcing solution or move to new tool is not in the middle of a GA schedule.

Take the Plunge

As a manager of more than 35 employees and mom of 3-year-old-twins, making time for myself is always a challenge. Making time for others is even harder – but ever so important. I love my job and take my role as a service provider very seriously. But last night, when I got the 11 PM email from a customer who urgently needs 400 pages of PDFs and Helps for an entirely new release within the week, I didn’t have to take a long pause before giving my answer.

Tomorrow morning I’ll be swimming the Kinneret to raise money for a wonderful charity called Sadnat Shiluv. I got sponsors, I got in the pool and I am ready. A few years ago, I probably would have cancelled my participation in the swim to make sure this project got off the ground. Instead, I am going to trust the amazing team of writers and support staff I have put in place and go swimming instead. I don’t have to sacrifice my personal goal…the work will get done and we’ll make the deadline. We always do.

It is so important to recognize that, like you, your employees are people who have families, struggles, relationships, needs, aspirations and goals. Don’t force yourself or your employees to choose between personal goals and work deadlines. They can co-exist if you build and foster the right working environment to support it. It really is win-win for everyone.

The Green Jello Theory

My first leadership experience within an organization was a total bust. I was involved in a youth group as a pre-teen and decided to plan a “social” – you know, a group of guys, a group of girls, some music and some food. After hanging fliers and making tons of phone calls (this was before the days of SMS and Facebook), you can imagine my disappointment when a just handful of people showed up. Myself, a few losers and the girl who was helping with refreshments. It was a pretty lame crowd. What happened to all the people I spoke with that had committed to come? Dejected and ready to resign my post as social coordinator, someone told me about The Green Jello Theory.

It’s no secret that if you want people to feel invested in any kind of project, they need to feel responsible for the outcome. They have to perceive themselves to be an integral part of the process without whom success would be impossible. What does this have to do with green Jello? The story goes something like this: a shy girl was invited to participate in a club. She was seriously considering bailing out, but she remembered that she was asked to bring green Jello to the meeting and had agreed. She had no idea why, but she knew that her Jello was important to whatever activity was going to take place. So reluctantly, she shows up with her bowl of Jello and it turns out that the Jello wasn’t all that important at all. What was important was that she showed up, had a great time and become involved in the club. The rest is history.

Shame on You!

There is a reason why developers cringe when they hear the words “documentation” and “technical writing.” It is because of situations like the one I heard about last week when I visited a start-up seeking a new approach to documentation. It would be an understatement to say that what I heard from them was shocking. I am seriously embarrassed on behalf of my profession right now – and I do not tend to embarrass easily.

Alpha (not their real name) is a software start-up that is being completely victimized by a so-called technical writing outsourcer. This outsourcer has decided that every time they touch Alpha's documents, they can charge for a minimum of 12 hours of work – even though they admit that significantly less time is usually spent. Can you imagine paying for 12 hours worth of work when the job actually took 45 minutes? Not only that, but deadlines are regularly missed because this outsourcer claims to be too busy with other customers to complete these small projects on time.

To add insult to injury, the documentation is bad. Really, really bad. It is not task or workflow oriented and has been deemed useless by the developers and the customers. In fact it is so bad that the software’s development team decided to create their own version of usable documentation that they now embed into the product. And when Alpha inquired about an online help option, they received a quote from their so-called service provider for many, many thousands of dollars. Had the provider used the right tool in the first place, it should have been free or maybe cost a few hours of work. Certainly not months!

Face the Future Head-On

Innovation is one of my favorite subjects. I have the utmost respect for those who continually stay at the top of their game and never rest on their laurels. Every day, I strive to do the same.

Rick Newman’s article 6 Strains On Your Financial Future is a must-read. Instead of taking things as they come, he outlines how each and every one of us can be proactive in facing the future head-on. Here is an excerpt:

"Uncertainty is here to stay. The recession is over, but it's not back to business as usual. The U.S. economy is fundamentally changing, as foreign competition gets tougher, technology revamps the way companies operate, and old skills become obsolete quickly. There will still be good opportunities for workers who are able to adapt, but those expecting a paycheck for simply showing up every day and doing the same old thing will be the first to go when things change. "Be flexible and work outside your protected comfort zone," says Susan Goldberg, a New York executive search consultant. "The individuals willing to take risks and operate differently will succeed.""

How to prepare: "Ask what could go wrong with your job, income, and finances. Anticipate changes instead of simply waiting for them to happen. Identify your vulnerabilities and address them, whether that means getting more education, changing careers, or downsizing your lifestyle so you can save more."

Stand Out from the (Technical Writing) Crowd

Breaking in to a new field is really, really tough these days. I have been receiving a steady stream of emails and phone calls from technical writing course graduates who are looking for work and I am asked constantly what advice I have for how to land that first job. I’ve blogged previously on what hiring managers are looking for in a CV, but what can be done beyond that? It’s no secret that it takes the right combination of education, experience, “protexia” and luck to land a technical writing job in Israel. But here is some practical advice on how you can go above and beyond and get yourself noticed in today’s ultra-competitive job market:

Star Search Results

Drumroll please...the results of Star Search 2010 are in. Besides a few worthy standouts, the quality of respondents was underwhelming, to say the least. So without further ado, here are a few friendly pointers for getting your technical writing CV noticed instead of being sent directly to the recycling bin. To those of you who recognize yourselves in one or more of the examples below, no need to thank us for the free tips:

Save your CV as a PDF or as a well-formatted Word Document. And by all means, pay attention to the file name! We really don’t need or want to know which version this is or when you revised it. If your name is Joe Smith, then save your CV as Joe Smith CV or even Joe Smith Technical Writing CV. But whatever you do, do NOT name it “Resume IT-Tech Update 10-07 Rev IL2b-1” It may make sense to you, but to a hiring manager it simply looks ridiculous.

Star Search 2010

There are some excellent technical writing courses being offered in Israel and via distance learning. And with a steady stream of graduates entering the technical writing market on a steady basis, you’d think that finding outstanding candidates to fill jobs would be a cinch. But for some reason, a good man (or woman) is hard to find these days.

It takes more than being a great writer to make it as successful technical writer. I’ve written about this before and can’t stress it enough:  The “tech” in technical writer has value. Real value. I am not interested in debating the issue further, suffice it to say that after nearly 20 years in the business, experience has shown us that technical people make the best Tech-Tav writers. So if you are a native English speaker with strong writing skills and experience or training in engineering, computer programming, IT, mathematics, etc. and either live in Israel or are thinking about Aliyah, I invite you to send me your CV (even if you have never taken a technical writing course). Technical writing is a great option for native English speakers since it allows you to work and write in English while utilizing your technical skills and education. Not a bad combination. Let’s try and figure out whether technical writing could be the next step along your career path – we really enjoy training new people and providing opportunities for personal growth and professional development, so what have you got to lose?

Google Ads Rant

Why can’t I go anywhere on the Internet anymore without annoying Google Ads popping up everywhere? I recently went to Target.com to buy booster seats for my twins. I knew exactly what I wanted because my mom sent me a direct link. I expected to go to the page, confirm that she is the world’s best shopper and proceed straight to checkout. But as I scrolled to the bottom of the page, I found something kind of shocking. On not one, not two, but on THREE different sections of the page (see below for two of them) were Google Ads lulling me to other sites that promised “great bargains,” “fast delivery” and “huge selection” of car seats and other items! Hello, Target! Is it just me, or are these ads irritating your customer base and sending your potential consumers to do their shopping elsewhere? Why in the world would you want to do such a thing?

Tech-Tav does run a Google Ad campaign. It almost guarantees that we appear on the first page of results when people search for relevant keywords, which is beneficial even if the searcher doesn’t click our ad. (And please don’t try it out now to be cute, we pay per click!) But we would never run ads on our site for other technical writing services or documentation companies on our site. It just doesn’t make sense and I am baffled as to why any business would agree to participate in such a scheme. Why spend all that money and time building and promoting your site in order to attract customers if you’re just going to send them away via another vendor’s Google Ad? Is it just me, or does that sound like a bad sales strategy?!

Leading Ideas

When I started at Tech-Tav nearly 10 years ago, the company consisted of seven technical writers working for six different companies. Today, we have grown to nearly 40 writers and, in an average year, work for more than 100 companies. Back then, I was relatively young and even recall being asked by more than one customer if I had finished college! (I had.) Through the years, friends, colleagues and clients have often asked me about my background...how do I know what to do? Where did my management skills and training come from? And how did I, at such a young age, manage to change and grow Tech-Tav into what it is today?

Most of what I know I learned not in kindergarten, but back in high school when Sue Ellison, Director of Distribution for WetSeal, took a chance on me. I was a 16-year-old looking for a part-time job who happened to live within 2 miles of the company corporate office and national distribution center. Sue was an outstanding role model of an effective manager, an influential leader and a true friend. She gave me a job and so much more.

Time to Face the Fonts

Serif or sans-serif? Normal or narrow? Choosing the right font for a technical document is not as simple as just going with your personal preference. I read an interesting piece on Yahoo! about large organizations that are literally saving thousands of dollars by simply changing their font type. For example, when printing thousands of pages, a narrower font can reduce your page count, saving paper and slimming down your document. And Serif fonts use considerably less ink so your printing costs will be lower.

However attractive the cost savings may be, it is most important to keep in mind the requirements of your end user. If your User Manual will be accessed electronically, you better make sure that your chosen font is one of the well-known classics. If you opt for an obscure font (no matter how great it looks on your screen), you may find that it is substituted for something really awful when your users open the PDF on their machines. For printed documents, you need to weigh the cost- and tree-saving potential against the ease of readability for the end user. A document that no one wants to read because the font is too small is of little use to anyone.

One thing is for certain – there is a lot more to font selection than meets the eye. Here are two fun and useful font-related links:

Periodic Table of Typefaces

Typeface Decision Tree

A font walks into a bar and orders a drink. The bartender shakes his head and says, “Sorry, we don’t serve your type here.”   (Groan)

Why the "Tech" in Technical Writer has Value

I just hung up the phone with the VP of R&D from a new, cutting-edge startup. They need a technical writer to produce a Solution Guide for a complex HW/SW product. I quoted him a realistic price for getting the job done. He paused, said it was way more than they were expecting to pay, and let me know he’d get back to me after checking into other options. I’m sure he will check around and find lots of unemployed writers to do the job “cheaper.” But I hope I made it clear to him that cheaper in the short run is almost never cheaper in the long run, especially when it comes to producing quality technical documentation that customers want to read.

A “cheaper” technical writer probably has a degree in a non-technical field. He may have successfully completed a technical writing course or a 3 or 4 month technical writing internship and is hopefully even a decent writer with native English. But is he actually technical? Will he waste valuable and expensive R&D time by needing to be taught the ins and outs of the technology, starting with the basics? Will he have ever before seen – let alone used – a similar product in a professional setting? Can he really put himself in the place of the end user in order to most effectively meet his needs? Will he be able to review the product and his documentation for technical inaccuracies as well as grammatical and layout errors?