Tips for the HelpGram Writing Process


Quick Reference: Tips for the HelpGram Writing Process

  • Understand your topic.
  • Brainstorm.
  • Outline.
  • Don't worry.
  • Stick to your topic.
  • Be crisp, clear, and direct.
  • Be helpful.
  • Refer to this writing guide repeatedly.
  • Read HelpGrams.

Understand your topic
Your e-ternship director will assign a topic for you along with brief descriptions of the information that each topic should cover. Have a clear understanding of the topics before you begin writing your HelpGrams. If the topics that you've been assigned are unclear, ask your group editor to clarify them for you. If you need further explanation, contact your e-ternship director.

Also, familiarize yourself with your topics by doing sufficient research. As a rule, find at least six Web sites to base your research on. You can use three Web sites for recommended links and three for background information. Using six Web sites will enable you to double check facts and will increase your chances of finding interesting or surprising information to include in your HelpGrams.

Brainstorm
Once you have an understanding of your topic and your purpose for writing, begin your research. Then, generate ideas for how you will address your reader (person, tone, tense etc.) and for what information will be most useful to the reader and will most effectively convey your message.

Outline
Outlining can help you organize your thoughts and arrange the content of your HelpGrams in a chronological or inverted pyramid style. Having a clear sequence and logic to your content will enhance the readability of your HelpGrams and will increase your chances of holding the reader's attention.

Don't worry
Your first few HelpGrams should take you a few hours or more, as you get the hang of HelpGram writing and online research. But as your write more HelpGrams, this process will become second nature. So don't panic! We have many resources and tools to share with you. And you can always ask your e-ternship director for help in finding relevant Web sites, statistics and up-to-date resources.

Stick to your topic
If your HelpGram is broad, don't discuss a non-essential issue that can be raised in another HelpGram. If the HelpGram is very specialized, cover the topic well, making little generalizations.

Be crisp, clear and to the point
A clear and direct tone increases the reader's understanding of the issue and will hold the reader's attention. If you follow all the writing guidelines in in this guide, you will write effective HelpGrams.

Keep the readers in mind
Try to out yourself in the reader's position when writing your HelpGram. Ask yourself the following questions: Am I being clear? Would a reader find this information useful? Would this information help my reader to resolve an issue or problem? Would a reader feel engaged or insulted by my HelpGram? Include facts and insights from your research to avoid offering users common-sense information. For additional information on writing read-centered HelpGrams,
visit the following page: Writing Informative & Useful HelpGrams.

Assume the reader has an eighth grade reading level
Believe it or not, many books and articles are written for readers with an eighth grade reading level. We want to offer information that can be read easily, without resorting to a dictionary. The goal of HelpGrams is to convert complex issues into quick, clear, and easy-to-read formats.


Reference this writing guide repeatedly
This writing guide will serve as an handy reference when you begin writing your HelpGrams. Review this guide as much as possible to ensure that you're writing HelpGrams that are consistent with our mission and our editorial standards.

Read HelpGrams
As you acquaint yourself with the style and format of HelpGrams, check your HelpGrams against those already posted. They will be your best guides to effective HelpGram writing.

Back Next