Microsoft Subnet An independent Microsoft community View more

Tips to Help Content Editors Create Better Content for SharePoint Pages

In keeping with my New Year’s resolution theme for January, I’d like to share some tips for content authors and organizers who are creating content for SharePoint sites (or really, for pretty much any website). The tips are outlined in the post below, but if you would like a document that has them all – all formatted in a clean table with a few extra tips about file naming thrown in – please download the recently updated SharePoint Content Authoring Quick Guide from my website (for a quick link, use this).

Tips and Good Practices for Page Content

1. Tone

  • Overall, the tone should be smart, concise and helpful, as well as promote corporate values.
  • Copy should be consistent and appropriate for the target audience. Headline copy should be direct.
  • Use plain language to make your copy crisp and easy to consume.

2. Keep Your Pages Fresh

  • Encourage return visits by giving users something new to learn.
  • Keep your site current with value-added information.
  • Check and update your page regularly and review all document content at least every six months, deleting or updating content that is no longer relevant.

3. Spelling Counts!

  • Check your page for spelling and grammatical errors every time new information is added or changed.

4. Limit Your Message

  • Online attention spans are short. Limit your message to three key ideas within a content "block."
  • In Calendar and Announcement entries, keep the content short. If you need to reference more information, write a document, upload it to your document library, and put a hyperlink in your calendar or announcement entry.

 5. Remember Your Audience

  • When creating content for your page, be sure to consider the reader. When structuring your content, group ideas that are relevant to the specific audience.
  • Site users are in search of information and tools for specific tasks. Before creating any type of content, think about:
    • What would the user want or expect to find?
    • Are there common requests for information from your department or team? If so, make sure that this content is easy to find on your page.
    • Is there an obvious path to and from content that users would look for?
    • Are the headlines and copy written in an engaging, concise and relevant manner?

 6. Start With the Main Topic

  • Think like a journalist when you write text for a Content Editor Web Part or add text to a page.
  • Start with your main point, follow with supporting information, and end with a link to more detail on a subsequent web page or attached document. Users who are scanning your site will quickly see what is on the site and will then be able to click through for more information.

 7. Put the Important Information at the Top

  • Users do not always scroll down to see the rest of the page.
  • Be sure the points you want to convey are within the part of the screen that displays when you arrive at the page. Do not make the user scroll to find the most important content.
  • Do not say “refer to the xxx section on this page for more information.” If you refer to content either on your site or on another site, make a direct hyperlink to the content.

 8. Write Concisely

  • People read differently when looking at a computer screen.
  • Make the content in your Calendar and Announcements easy to scan, using short bullet points whenever possible.
  • Do NOT WRITE IN ALL CAPITAL LETTERS.
  • Do not use underline to emphasize a point. On the internet, an underline implies that the content is a hyperlink. Use bold if you need to emphasize a point, but don’t use it too much.
  • Italics do not display well in a browser. They should also be used sparingly, for example, to refer to proper names or to emphasize text.

 9. Watch the Fonts and Rich Text ... less is more!

  • Don’t go overboard using all the features, colors, and capabilities of rich text fields. Refer to the corporate style guide for specific font and color requirements.
  • Live the mantra “just because you can, doesn’t mean you should” when you are putting content in rich text fields. Be very mindful about using multiple colors and highlights on text. Less is more when you are writing for the web.
  • Use the default standard font for content where ever possible.

 10. Use Numerals - Don't Write Out Numbers

  • The best practice for the web is to write numbers with digits, not letters (23, not twenty-three).
  • For the most part, use numerals even when the number is the first word in a sentence or bullet point.

 11. Write Effective Hyperlinks

  • Write links like you would write a heading – use 8 words or less.
  • On any one page, every link should be unique, independent, and separate. As a best practice, have just one link to a particular piece of content on each page so that you don’t confuse your users.
  • “Lead with the need” – If you have a guide to on how to install a widget, write the link: “Installation instructions.” Don’t write: “How to install this widget.” Otherwise, you have a lot of links beginning with “How to.”
  • Use the following guidelines to create hyperlinks:
    • OK: Click here for the latest application form
    • Better: Download the latest application form
    • Best: Latest Application Form

 12. Always Add a "User Friendly" Description for SharePoint Hyperlink Columns

  • Write a user friendly description for all hyperlink site columns (in lists and libraries) or fields (on articles and other pages). Enter the URL in the URL field and a “friendly” name for the description.

Tips and Good Practices for Using Images on Pages

13. Choose the Best Image Format

  • Images add richness and interest to your site, but large images take a long time to load over slow internet connections and images that take up a lot of room can make it harder to find content.
  • All images that you load to SharePoint should be “optimized for the web” (which may mean reducing the quality of the image) so that they do not take an inordinately long time to load.
  • If you are saving an image to upload to SharePoint, choose .jpg for photographic images and .png for other images such as logos, drawings, or icons.

 14. Limit the Use of Images Unless they Provide Value

  • Users generally don’t like “dancing” images on web pages – they may also distract from your main message.
  • Try to avoid the use of animated .gif images and limit the use of Flash or moving images unless they provide instructional or added value to the user. Don’t animate just because it’s “cute.”

15. Align Image Colors with the Branding for Your Site

  • If you are using images as navigation links or as a main image on your page, make sure that the image colors are aligned with your branding.
  • To ensure a consistent user experience, Images that are used for navigation should be aligned with the color palette used on your site. In other words, choose colors and a tone that work with rather than distract from your branding.

 16. Don't Over-Use Promoted Links Lists

  • Promoted links lists are a great feature of SharePoint 2013, but they should not be used to replace all links lists.
  • Some good uses for Promoted Links:
    • Guiding users through a series of steps (i.e. for training).
    • Showcasing key topics on a page that aggregates content.

 17. Use Icons for the Right Reasons - and when they make sense

  • Before you decide to use icons for navigation, read this article about Icon Usability from the Nielsen Norman Group. It has some really helpful information and guidelines.
Join the Network World communities on Facebook and LinkedIn to comment on topics that are top of mind.
Related:
Must read: Hidden Cause of Slow Internet and how to fix it
Notice to our Readers
We're now using social media to take your comments and feedback. Learn more about this here.