The Days of Wine and Charoses

by Mark L. Levinson

As I wrote a couple of years ago on Techshoret, the important principles of technical writing are already present in the Hagaddah, the venerable promptbook for the Passover meal.  We moderns have invented nothing.

A standard Hagaddah begins with infrastructure requirements.  It specifies a physical environment free of breadcrumbs and similar contaminants.  Also in advance, it lists the major necessary materials for the project: bitter herbs, egg, etc.

It has a table of contents that divides the book into fifteen parts:  Blessing, Handwashing, Greens, Matzo-splitting, etc.  That’s quite a few divisions, so there are also milestones on a larger scale — cups of wine — to congratulate and reward the readers as they progress.

To provide direction, the Hagaddah explicitly presents the question — in fact, four questions — that it proposes to answer.  And it uses four quick user profiles — the four sons — to explain the target readership in whose terms those questions will be answered.  But in between, it anticipates the challenge of the experienced reader who is inclined to feel entitled to an exemption from the chore of going through all the material again.  Rather than answering the challenge confrontationally by implying that the reader may be too self-confident about that, instead the Hagaddah embraces the reader as an equal and says “Even granting that we are all wise, all knowledgeable, all senior people, and we all know the discipline,” still we go by the book as a matter of duty.

Having said that, the Hagaddah proceeds in painstaking detail, not letting a word or sentence pass unaccompanied by any explication that might be required.  When we reach the ten plagues, which may be a bit hard to recall in sequence, the Hagaddah suggests remembering them as three short acronyms.  Once again it is tactful — almost Japanese in its tact.  Rather than saying, “Here’s something to help you remember,” it merely says “Rabbi Yehuda used to abbreviate them this way.”

Rabbi Yehuda, Rabbi Yosey, Rabbi Eliezer, and the others are of course referenced by name, and not only is it good authorial practice and good Jewish etiquette to acknowledge sources; using people’s names in narration is also good technical writing because it makes general ideas concrete and immediate.  Instead of “You can sandwich the bitter herbs between pieces of matzo,” the Hagaddah says, “When the Temple was still standing, Hillel would sandwich the bitter herbs between pieces of matzo.”  A procedure is easier to remember when it’s a story with people and context.

Parallel structure is another aid to the reader, and it abounds in the Hagaddah.  “If He had fed us with manna and not given us the Sabbath, it would have sufficed for us.  If He had given us the Sabbath and not brought us to Mount Sinai, it would have sufficed for us,” and so on.  Customarily this particular list involves a bit of participation by everyone, illustrating another principle for writers:  if there’s an opportunity to suggest a relevant little activity, that’s much better than page after page of uninterrupted reading.

And lastly, like any well-constructed manual, the Hagaddah relegates optional material to appendixes.  May you enjoy the days of wine and charoses, as my mother called the holiday, and if I’ve added something to your appreciation of our classic Passover text, e-mail me and let me know how it ends.  My family never gets all the way through it.

Comments and questions are welcome:

 

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.