Have You Marinated Your User Guide Lately?

by Mumpy

add a comment

The other day somebody sent me a funny sentence taken from an advert for a technical writer published on Jobnet. The advert stated they were looking for a technical writer who was good at writing, editing and marinating technical articles.

How I laughed; how I chortled; how I giggled; how I suddenly had a nervous breakdown when I realized it was my very own company that had published that Job Description.

I rushed like the wind, a forbidding wind, to HR. “All job adverts are edited by the marketing writer” they said to me.

Okay I thought, now that you mention it – marinating is not such a bad word. In fact – it’s quite a clever way to look at technical writing. Just like the piece of chicken soaking up the ketchup and the wine and the mustard; so too the technical writer takes the raw manual and uses it to soak up the information and the concepts and the lingo to produce a deliciously grilled final product.

When I finally got hold of the marketing writer, he said he had never seen the job description before. My simile flew out of the window quicker than you could say “Put another shrimp on the Barbie” and I promptly sent a condescending, snobby email to HR, Director of Support, Director of Products, the guy who once fixed the radiator in my house and a distribution list of everyone in my high school class.

HR realized immediately that marinating was a gross error and in fact they had meant to write “maintaining”. They sent me an email promising to find the source of that mistake and shoot him at dawn without offering him a blindfold (they didn’t actually say that in the email – but it was inferred).

But you know – for that half an hour – when I was prepared to accept the marketing writer’s clever use of language – I really got into the whole marinating concept. And so I say to you, my colleagues, have you marinated your User Guide lately?

Link to all episodes

 

9 comment

Anne Lustig-Picus 5 year, 10 month ago

Hilarious! Thanks.

Very Stupid, I almost gagged.

Somedays, it would better if the writer is marinated rather that the manual.

Marinating is a good idea. I do that with email messages: save as draft, read it later as if I received it, then send. When I have time, that is.

Srisaila Patil 5 year, 10 month ago

I compose mails, marinate them on the taskbar for a few hours at times, keep revising them at brief intervals until I feel confident that I can send them off.

I love to marinate my documents when the deadline is beyond the horizon. I like your Company's requirement of marinating technical articles! I should love to join you for a change!

Anne Lustig-Picus 5 year, 10 month ago

The combination of technical writer and Aussie in me can't resist objecting, even after several days of rumination/marination!

I assume you mean the BBQ type of barbie, in which case a small "b" is required. Otherwise, doll-lovers the world over may object to their love objects becoming caked in shrimp!

Hmmm, all this discussion about marinating is making me hungry for a well marinated, BBQ'd manual ;)

To Anne, Yes I know, I know! Not only a lower case b, but also barby would have been a better spelling! Oh well - next time!

Useful Information

  • Job Listings (visible to only members)

  • Employee Benefits

  • Other Sites and Resources

    Survey Reporting

    Q2 2010 Survey Results

    Requires access rights

    Employee Salaries (18 pp)

    Freelance Writer Rates (11 pp)

    Q4/09 Copy Editor Rates (9 pp)


    Columns on Elephant

    Translatable but Debatable

    Each month, Mark L. Levinson presents one hard-to-translate Hebrew word at a time for discussion.

    Of Mice and Keyboard Shortcuts

    Michael Cohen will teach us practical shortcuts that save us time and make our lives easier.

    The Why of Style

    Mark L. Levinson examines the big and little factors that make writing effective.

    Broken Bell Education in Israel

    David Siegel looks at the problems in education in Israel and discusses what can be done.

    Jonathan's Tool Bar & Grill

    Jonathan Plutchok identifies free or inexpensive utilities or plug-ins that save time, increase productivity, improve your computing environment, perform a task you otherwise couldn't do... or is just too much fun to ignore. This column has grown into its own blog at http://jonathanstoolbar.blogspot.com where you can find new issues every week.

    It's in The Script

    Paul Schnall teaches us about the power of FrameScript and how to use it.

    Do it Yourself

    Did you ever wonder what was inside a PC, laptop, or other microcomputer system? Michael Cohen teaches us what's inside and how to configure and build our own.

    Coaching for Success

    Dr. Tal discusses the principles of professional coaching, focusing on resiliency.

    Hunters and Gatherers

    Eric Gluch looks at modern marketing.

    Moving to Chelm

    Esther Shira Stepansky takes us on a humorous adventure in the modern day land of Chelm as we look at some of the challenges of making aliyah and finding work in Israel. Making aliyah is supposed to be the fulfillment of my of your Jewish identity, so why does Israel make it so difficult?

    Why am I a Tech Writer?

    By Michael Altman

    Life as a Tech Writer

    By Mumpy

    Building Bridges (in Hebrew)

    Dr. Zaidel discusses another aspect of mediation within the framework of Israel's court-approved Alternative Dispute Resolution (ADR) process.

    Don't Forget

    Hezy Asher teaches us how to improve our memory.

    World of Podcasting

    Tom Johnson's podcast episodes, provide tips on recording presentations, and other podcasting related news and events.

    Effective Management ניהול אפקטיבי

    By Eitan Reuveni

    Scribblin' With Steph

    By Stephanie Freid

    Life in Northern Israel

    By multiple authors

    Life on the Southern Front of Israel

    By Israel Ivri

    Event Summaries

    Summaries of events held by Elephant and other organizations throughout the Israeli technical/marcom community.