Style Guide Quick Reference Summary

100% helpful (1/1)

While all content contributors and content managers should familiarize themselves with the full style guide, this Quick Reference Summary offers a broad overview and examples of best practices. The Community team recommends printing or bookmarking the summary for easy access when authoring content.

  • Be objective. State real facts and back them up. If you're offering an opinion, make sure you label it as such and say whose opinion it is.
    • Bad: The financial services industry is known to comply with the most complex regulations in the world.
    • Good: By one count, banks must track an average of 200 regulatory revisions globally per day. (Include link to research.)
  • Be human. Write for real people. Be interesting. Reflect what's important to your reader.
    • Bad: BigCorp, Inc., created a Center of Excellence.
    • Good: Jane Doe of BigCorp, Inc., created and led a Center of Excellence.
  • Be concise. Don’t waste the reader's time. Make every sentence count. Avoid wordiness and excessive flourishes or color. (The average reader reads at an eighth-grade level.)
    • Bad: The sales team is equipped to carry out a more responsive sales process.
    • Good: The sales team can respond faster.
  • Avoid first person. Avoid “I/me” references; use "we/us." (E.g., "we recommend" or "contact us.") Write for “you.” (E.g., “you should do this” or “next, you will click that.”)
  • Get active. Choose the active voice ("Rita did this") over the passive ("This was done by Rita," or worse, "This was done"). Avoid starting sentences with "There is," "there are," "this is," "it is," and similar phrases.
    • Bad: The platform will be updated.
    • Good: Anaplan will update the platform.
  • Choose strong verbs. Use verbs specific to the action.
    • Bad: Anaplan will be having a User Group Meetup.
    • Good: Anaplan will host a User Group Meetup.
  • Help your reader. Keep it simple. Make sure one idea flows into the next logically.
    • Bad: Anaplan is committed to exceeding your expectations for support during all interactions with our employees and our software, because your success is our success.
    • Good: Your success is our success, and we are committed to supporting you.
  • Use Anaplan-preferred terminology. Become familiar with Anaplan’s preferred spelling, capitalization, and punctuation for frequently-used terms. (E.g., “end user,” not “end-user;” “Center of Excellence,” not “CoE;” etc. Do not capitalize terms like “module,” “model,” etc.)
  • Always write in present tense, unless specifically referencing past events
    • Bad: The process was designed to illustrate how...
    • Good: The process illustrates how...
  • Use correct punctuation. Do not use a double space between sentences. Punctuation always goes within quotation marks. 
Contributors
Labels (1)
Version history
Revision #:
3 of 3
Last update:
‎04-18-2018 10:16 AM
Updated by: