Content Guide

ProudCity -

*Review and comment on the ProudCity Content Guide.

Intro

The ProudCity Content Guide is a resource to help you better understand and use best practices in writing for web-based visitors, as well as get you started in developing your own content on the ProudCity platform.

Plain language

From plainlanguage.gov:

Plain language (also called Plain English) is communication your audience can understand the first time they read or hear it. Language that is plain to one set of readers may not be plain to others.

Written material is in plain language if your audience can:

  • Find what they need;
  • Understand what they find; and
  • Use what they find to meet their needs.

Tips

From plainlanguage.gov:

  • Less is more! Be concise.
  • Break documents into separate topics.
  • Use even shorter paragraphs than on paper.
  • Use short lists and bullets to organize information.
  • Use even more lists than on paper.
  • Use even more headings with less under each heading.
  • Questions often make great headings.
  • Present each topic or point separately, and use descriptive section headings.
  • Keep the information on each page to no more than two levels.
  • Make liberal use of white space so pages are easy to scan.
  • Write (especially page titles) using the same words your readers would use when doing a web search for the info.
  • Don’t assume your readers have knowledge of the subject or have read related pages on your site. Clearly explain things so each page can stand on its own.
  • Never use "click here" as a link — link language should describe what your reader will get if they click the link.
  • Eliminate unnecessary words.
  • Short, direct sentences
  • Short paragraphs, use lots of paragraph breaks
  • Use subheadings
  • Avoid jargon and use plain English
  • Less is more
  • Active voice

Style guide

We recommend using the Associated Press Stylebook for content styling. The 18F Content Guide is an excellent primer to both AP Style and general best practices:

Tools

Resources

Migrating content

Before migrating content from your old site to the new, it is best to assess what should eliminated, retained or re-purposed.

Resources

Getting Started

Answers

ProudCity Answers lets you easily add searchable, topic-specific plain language information into your website.

Common questions:

  • How do I pay my water bill?
  • How do I apply for a city job?
  • What is my trash and recycling pickup day?

Guide

To help you get started, we created the ProudCity Answers Guide that categorizes government-specific topics and relevant questions you can use to create your own ‘Answers’ content.

You may notice questions in multiple categories, and this is intentional. For example, a person trying to renew their driver’s license can find information under both ‘Transportation’ or ‘Permits and Licenses’ because both categories are logical places to look.

News

ProudCity News allows you to easily add various news types to your website.

Examples:

  • City news
  • Mayor news
  • Press release
  • Blog posts

Events

ProudCity Events allows you to easily add events to your website.

Examples:

  • Community
  • Mayor
  • City Council meetings

Tips:

  • Always include name, date, timeframe, location, description, contact and RSVP or payment is applicable.

Social media

ProudCity Social Wall aggregates and displays your latest social media posts on your city website.

We support the following social media platforms:

  • Facebook
  • Twitter
  • Instagram
  • YouTube
  • Pinterest
  • Flickr

Resources:

  • Guide to writing for social media (Centers for Disease Control)

Agency directory

ProudCity makes agency contact information more accessible.

Commonly searched agencies:

  • Mayor
  • City Council
  • Police
  • Fire
  • Health
  • Parks & Recreation
  • Public Works
  • Finance

Tips:

  • Provide comprehensive contact information:
    • address
    • phone/fax
    • website
    • email address
  • Include business hours

About

When providing an overview of your city, keep in mind the various audience types looking for information:

  • Residents: Describe your community and why people want to live or move to your city.
  • Businesses: Describe your business community and economy.
  • Visitors: Describe attractions and activities for tourists.

Common about page details:

  • Census information: County, state and population
  • Unique highlights: Cultural institutions, businesses, landmarks, historical information, environment, parks, sports, etc.)

Tips:

  • Wikipedia city pages provide a great format for describing your city (example: Oakland, Calif.)

Distribution

Once you’ve developed your content, there are a number of distribution avenues available to effectively communicate to as many residents as possible (many of which integrate with the ProudCity platform).

These include:

  • Social media (Facebook, Twitter, Instagram, YouTube, etc.)
  • Newsletters (MailChimp)
  • Feeds (automatically included in all ProudCity websites via RSS)

Resources

Have more questions? Submit a request

Comments