Plan Your Project: Difference between revisions

From Way With Words
 
(52 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Plan Your Writing Project==
__FORCETOC__


=== What is Your Project's Purpose? ===


* Are you summarizing information for the Planning Board or District Council, informing the public, offering solutions to a problem or pursuing another objective?
== Plan Your Project==
* Knowing the answer to this question will guide your choice of words, tone, and the project's <u>'''length'''</u>.
'''<big>Identify the Purpose</big>'''
* For instance, decide if a formal tone is necessary or if a less formal approach will suffice, provided it remains professional and, where necessary, authoritative.


=== Focus on Your Audience ===
Clearly define your project's objective.
* Are you summarizing information for the Planning Board or District Council, informing the public, studying a problem or something else?
* Your purpose shapes your language, tone, and document length.
* For instance, use a formal tone for documents to be reviewed by the Planning Board or other officials, but a professional yet conversational tone works for public communications.
'''<big>Know Your Audience</big>'''
* '''Identify your readers and their characteristics.''' Tailor your content to their needs, whether they are families, business owners, or environmental advocates. Consider their age and familiarity with technology.
* Focus on what your audience ''needs to know'' not just what you ''want to say''.
* For multiple audiences, adapt your message or create different versions. The Publications Section can help tailor your communications.


* '''Identify your readers and their characteristics.''' Are they likely to be individuals/families, small business owners, pedestrians, environmentalists? Consider their age range and technological proficiency.
<big>'''Need Help with Planning a Project?'''</big> 
* Think about what your audience ''needs to know'' rather than simply what you ''wish to convey''.
* If you are addressing multiple types of audiences, strategize how to adapt your message to meet everyone's information needs. Maybe it would help to have different versions of a document geared towards each target audiences; we are happy to work with you on tailoring your messages.


'''Need help with planning a project?''' Involve the [mailto:PPD-Publications@ppd.mncppc.org Publications, Graphics, and Web Development Section.] We offer:
The [mailto:PPD-Publications@ppd.mncppc.org Publications, Graphics, and Web Development Section] can assist with:  


# '''Content editing''' for documents, web pages, infographics, and presentations to check for errors, consistency, style, and branding. Bring your content, and we'll refine it.
# Custom '''images''', '''infographics, and charts'''  
# Creation of '''images''', i'''nfographics, charts, tables, and other data visualization''' to enhance readability and engagement.
# Drafting '''webpage content,''' including timelines, boundary maps, and contact details.
# Drafting of essential background content for your project's '''webpage,''' including history, purpose, timelines, boundary maps, and contact details.
# '''Social media strategies''' across platforms to broaden your message's reach.
# Development and execution of a '''social media strategy''' to promote your message across various platforms.
# Promotional materials design '''(posters, flyers, postcards, and banners).'''
# '''Consultant onboarding''' with publication specifications for consultant RFPs to create awareness of Planning Department standards.
# '''High-quality photos''', '''videos, and aerial drone imagery.'''
The Publications, Graphics, and Web Development Section will ensure that your events are professional, well-publicized, and thoroughly documented by:


* Designing promotional materials such as '''posters, flyers, postcards, banners, and other promotional materials''', and more.
== Organize Your Document in a Reader-Friendly Way ==
* Capturing '''high-quality photos''' and '''videos, including aerial drone imagery.'''
<big>'''Identify Key Questions'''.</big> Anticipate the questions your audience may have. What will they need to know to understand the subject? Focus on the essential information and remove unnecessary details.
 
'''<big>Structure Your Draft</big>.''' Arrange your content by the questions a reader might logically ask. Consider:
* Creating headings based on the topic addressed.
* Using a Q&A format, with questions as headings.
* Writing headings that form a complete sentence.
Each paragraph should be short, focus on a single topic, and include clear transitions, and a topic sentence.
 
'''<big>Ensure Logical Flow.</big>''' Start with key conclusions or outcomes to grab attention and set the context for what's next.
 
'''<big>Describe Processes.</big>''' If your content explains a process, clearly outline each step, including who is responsible and relevant timeframes. Use a [https://style.pgplanning.com/index.php?title=As_You_Write&veaction=edit&section=4 flowchart or other graphic] to make the process easy to follow.
 
'''<big>Begin with the End.</big>''' Readers usually scan messages to quickly find the important parts of the document. Unless you are writing a novel, the most important part of the document needs to be at the beginning. Here are a few ideas highlight key points. 
 
* Start long documents with an easily executive summary of conclusions or recommendations.
* Add callouts and sidebars to emphasize important details.  
 
== Improve Readability ==
'''<big>Use simpler sentences</big>''' that are easy to understand. Shorten sentences and paragraphs where possible and vary their length.


=== Start with the End ===
* Are you using words that your audience is familiar with?
Your reader is used to googling or using generative artificial intelligence products to get key messages quickly. 
* Is there a way to express the information simply that still provides your audience with the information they need to know?
* Does using a less precise, but more familiar word change the meaning of the sentence/paragraph '''from your target audience's perspective?'''


Here are a few ideas to keep your message front and center, particularly for a long document:  
'''<big>Example:</big>'''


* Include a summary at the beginning of a long document that captures the main conclusions, recommendations, or important insights.
<span style="color: red;font-size: 24px;">✗</span>"The proposed development will feature a multi-modal transit hub to facilitate interconnectivity and reduce the reliance on private vehicles, thereby promoting sustainable urban growth.
* Create a storymap for your project on the web.
* Add callouts and sidebars to your document to highlight important information throughout the document


== Organize Your Document in a Reader-Friendly Way ==
<span style="color: green;font-size: 24px;">✓</span>"The proposed building includes a station that connects different types of transport. The station will reduce residents' dependence on private cars, making the city more environmentally friendly."


'''Identify Key Questions'''. Anticipate the questions your audience may have about the topic. What will they need to know to have an adequate understanding of the subject? Think also about what information they don't need and remove it. 
'''<big>Other ways to improve readability:</big>'''


'''Structure Your Draft.''' Arrange your content based on these questions, following the order in which a reader might logically ask them. If appropriate, you may want to:
* '''Add white space''' between paragraphs.
* Create headings based on the topic to be addressed in that particular section.
* '''Use headings and subheadings''' (beyond section titles)'''.'''
* Adopt a Q&A format, using the questions as headings to guide your audience through the document.
* Replace narratives with [https://style.pgplanning.com/index.php?title=Use_Active_Voice&veaction=edit&section=3#Bulleted_or_Numbered_Lists '''bulleted or numbered lists'''] when possible.
* Make headings about each topic that form a complete sentence.
* Use '''bold''' or ''italic'' for emphasis; <u>'''avoid underlining'''</u> - readers may confuse it with a hyperlink.
* Replace long URLs with hyperlinks that use descriptive text.
* '''Use callouts or sidebars.'''
<span style="color:#0000ff"> Callout text stands out from the regular text on the page with a box or change in fonts and background color. Callouts emphasize points that you want the reader to focus from the main text, such as a quote or important statistic.</span>


'''Ensure Logical Flow.''' Start with the important conclusions/outcomes of the piece to capture the reader's interest at the beginning. This helps to set the context and importance of the information that follows.
A '''sidebar''' is a detailed callout that may include background information, glossaries, examples, or anecdotes. Sidebar text adds information to the main text instead of repeating it; the sidebar at the upper right of this page provides page tools and other information.


'''Describe Processes.''' If any of the information you are conveying to the public involves a process, set out that process clearly for the reader. Include a [https://style.pgplanning.com/index.php?title=As_You_Write&veaction=edit&section=4 flowchart or other graphic] that shows what needs to occur at each step as well as which actions are to be taken by the individual and which are handled by the Department and provide the appropriate time frames.
== Be Clear and Concise ==
== Be Clear and Concise ==
Government documents often use complex, academic-style sentences to demonstrate expertise that may not effectively communicate information to the general public. This bureaucratic style, with its dense and lengthy sentences, can hinder our mission and values by making it difficult for people and communities to understand our messages. While conciseness is valued, increasing the chance that your reader will understand your message is the ultimate goal. Using plain language doesn't always require you to shorten a sentence or paragraph. It is preferable to maintain the length of the section or include a few more words to make a concept clearer to your reader. See the examples below.


:::::::::::::::::::::::::'''Shorter'''
Government documents often rely on complex, academic-style sentences to demonstrate expertise, but this approach can hinder effective communication with the general public. The use of dense, lengthy sentences can make it hard for individuals and communities to understand our messages, which conflicts with M-NCPPC's values.
 
While plain language guidelines value conciseness, the goal is to increase the chance that your reader understands the message. Using plain language doesn't always mean shortening a sentence or paragraph. It's better to keep the length of the section or add a few more words if it makes a concept clearer to your reader. See the examples below.
 
'''<big>Make it Shorter</big>'''


<span style="color: red;font-size: 24px;">✗</span> "Appropriateness is evaluated by the Planning Board and the implementing agency for each specific project depending on community needs, environmental constraints, and right-of-way constraints, with final determination by the County Council."
<span style="color: red;font-size: 24px;">✗</span> "Appropriateness is evaluated by the Planning Board and the implementing agency for each specific project depending on community needs, environmental constraints, and right-of-way constraints, with final determination by the County Council."
Line 55: Line 79:
<span style="color: green;font-size: 24px;">✓</span> "The Planning Board and M-NCPPC assess project suitability based on community needs, environmental factors, and land use limitations, with final approval by the County Council."
<span style="color: green;font-size: 24px;">✓</span> "The Planning Board and M-NCPPC assess project suitability based on community needs, environmental factors, and land use limitations, with final approval by the County Council."


:::::::::::::::::::::::::'''Clearer'''
'''<big>Make it Clearer</big>'''


<span style="color: red;font-size: 24px;">✗</span> "With the prior written consent of the Planning Board, which is not to be unreasonably withheld, the Planning Board can grant, within 14 days of the application, the developer permission to assign the development agreement."
<span style="color: red;font-size: 24px;">✗</span> "With the prior written consent of the Planning Board, which is not to be unreasonably withheld, the Planning Board can grant, within 14 days of the application, the developer permission to assign the development agreement."


<span style="color: green;font-size: 24px;">✓</span> "The Planning Board may allow the developer to assign the development agreement within 14 days of the application. The board must give written consent prior to the assignment, and cannot withhold consent without reasonable justification."
<span style="color: green;font-size: 24px;">✓</span> "The Planning Board may allow the developer to assign the development agreement within 14 days from date the application is filed. The board must give written consent prior to the assignment and cannot withhold consent without reasonable justification."


<span style="color: green;font-size: 24px;">✓</span> "The Planning Board may allow the developer to assign the development agreement under the following circumstances:
<span style="color: green;font-size: 24px;">✓</span> "The developer may obtain permission from the Planning Board to assign the development agreement within 14 days of the application file date. The Planning Board cannot withhold permission without reasonable justification."


* within 14 days of the application, and
<span style="color: green;font-size: 24px;">✓</span> "The Planning Board may allow the developer to assign the development agreement:
 
* within 14 days of the application date, and
* with written board consent prior to the assignment.
* with written board consent prior to the assignment.


The Planning Board cannot unreasonably withhold consent to the assignment."
The Planning Board cannot unreasonably withhold consent to the assignment."


:::::::::::::::::'''Excessive detail, repetitiveness, or redundant/filler words removed'''
'''<big>Remove Excessive Detail, Repetitiveness, and Redundant/Filler Words</big>'''  
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 83: Line 109:
| "Many Metro stations offer bicycle storage, allowing riders to continue their journey on Metrorail or Metrobus."
| "Many Metro stations offer bicycle storage, allowing riders to continue their journey on Metrorail or Metrobus."
|}
|}
'''Tips''':
'''<big>Tips</big>''':
* '''Set word or page limits for your project''' and adhere to them; this will help you to review your document for the issues described above. If this writing project is periodical, challenge yourself to convey the same amount of information as the previous version in fewer words.
* '''Set word or page limits for your project''' and adhere to them; this will help you to review your document for the issues described above. If this writing project is periodical, challenge yourself to convey the same amount of information as the previous version in fewer words.
* This list of '''[[unnecessary words]]''' will help you to identify the passages that need to be shortened.
* This list of [https://style.pgplanning.com/index.php/Unnecessary_Words '''unnecessary words'''] will help you to identify the passages that should be shortened.
 
== Create Figures to Help Your Reader ==
A figure is a chart, table, graph, illustration, or infographic that can convey necessary information using a minimum of written text. Using figures makes your document more concise; it can also make the document less dense by increasing white space.
 
'''<big>Would you prefer to read this?</big>'''
 
Approximately 77.14 acres is designated retail, 116.16 acres industrial, 2.26 acres mixed used, and 14.08 acres office. The retail uses are concentrated along Bladensburg Road, Kenilworth Avenue, and Annapolis Road. Industrial is concentrated west of Kenilworth Avenue, in the Town of Edmonston. The little mixed use or office uses that exist in the sector plan area is centered in the core near the intersections of Bladensburg Road, Kenilworth Avenue and Annapolis Road. '''''(72 words)'''''
 
'''<big>Or this?</big>'''
{| class="wikitable"
|+'''<big>Land Use in Port Towns</big>'''<br>
 
<br />
!Use
!Size (Acres)
!Concentrated Areas
|-
|Retail
|77.14
|Bladensburg Road, Kenilworth Avenue, Annapolis Road
|-
|Industrial
|116.6
|West of Kenilworth Avenue in Edmonston
|-
|Mixed-Use
|2.26
|In the core near intersection of Bladensburg Road, Kenilworth Avenue, and Annapolis Road
|-
|Office
|14.08
|In the core near intersection of Bladensburg Road, Kenilworth Avenue, and Annapolis Road
|}
'''''(42 words)'''''
 
The [mailto:ppd-publications@ppd.mncppc.org Publications Section] can help you with creating figures for your projects or making your existing figures more reader-friendly.

Latest revision as of 16:05, 22 April 2025


Plan Your Project

Identify the Purpose

Clearly define your project's objective.

  • Are you summarizing information for the Planning Board or District Council, informing the public, studying a problem or something else?
  • Your purpose shapes your language, tone, and document length.
  • For instance, use a formal tone for documents to be reviewed by the Planning Board or other officials, but a professional yet conversational tone works for public communications.

Know Your Audience

  • Identify your readers and their characteristics. Tailor your content to their needs, whether they are families, business owners, or environmental advocates. Consider their age and familiarity with technology.
  • Focus on what your audience needs to know not just what you want to say.
  • For multiple audiences, adapt your message or create different versions. The Publications Section can help tailor your communications.

Need Help with Planning a Project?

The Publications, Graphics, and Web Development Section can assist with:

  1. Custom images, infographics, and charts
  2. Drafting webpage content, including timelines, boundary maps, and contact details.
  3. Social media strategies across platforms to broaden your message's reach.
  4. Promotional materials design (posters, flyers, postcards, and banners).
  5. High-quality photos, videos, and aerial drone imagery.

Organize Your Document in a Reader-Friendly Way

Identify Key Questions. Anticipate the questions your audience may have. What will they need to know to understand the subject? Focus on the essential information and remove unnecessary details.

Structure Your Draft. Arrange your content by the questions a reader might logically ask. Consider:

  • Creating headings based on the topic addressed.
  • Using a Q&A format, with questions as headings.
  • Writing headings that form a complete sentence.

Each paragraph should be short, focus on a single topic, and include clear transitions, and a topic sentence.

Ensure Logical Flow. Start with key conclusions or outcomes to grab attention and set the context for what's next.

Describe Processes. If your content explains a process, clearly outline each step, including who is responsible and relevant timeframes. Use a flowchart or other graphic to make the process easy to follow.

Begin with the End. Readers usually scan messages to quickly find the important parts of the document. Unless you are writing a novel, the most important part of the document needs to be at the beginning. Here are a few ideas highlight key points.

  • Start long documents with an easily executive summary of conclusions or recommendations.
  • Add callouts and sidebars to emphasize important details.

Improve Readability

Use simpler sentences that are easy to understand. Shorten sentences and paragraphs where possible and vary their length.

  • Are you using words that your audience is familiar with?
  • Is there a way to express the information simply that still provides your audience with the information they need to know?
  • Does using a less precise, but more familiar word change the meaning of the sentence/paragraph from your target audience's perspective?

Example:

"The proposed development will feature a multi-modal transit hub to facilitate interconnectivity and reduce the reliance on private vehicles, thereby promoting sustainable urban growth.

"The proposed building includes a station that connects different types of transport. The station will reduce residents' dependence on private cars, making the city more environmentally friendly."

Other ways to improve readability:

  • Add white space between paragraphs.
  • Use headings and subheadings (beyond section titles).
  • Replace narratives with bulleted or numbered lists when possible.
  • Use bold or italic for emphasis; avoid underlining - readers may confuse it with a hyperlink.
  • Replace long URLs with hyperlinks that use descriptive text.
  • Use callouts or sidebars.
 Callout text stands out from the regular text on the page with a box or change in fonts and background color. Callouts emphasize points that you want the reader to focus from the main text, such as a quote or important statistic. 

A sidebar is a detailed callout that may include background information, glossaries, examples, or anecdotes. Sidebar text adds information to the main text instead of repeating it; the sidebar at the upper right of this page provides page tools and other information.

Be Clear and Concise

Government documents often rely on complex, academic-style sentences to demonstrate expertise, but this approach can hinder effective communication with the general public. The use of dense, lengthy sentences can make it hard for individuals and communities to understand our messages, which conflicts with M-NCPPC's values.

While plain language guidelines value conciseness, the goal is to increase the chance that your reader understands the message. Using plain language doesn't always mean shortening a sentence or paragraph. It's better to keep the length of the section or add a few more words if it makes a concept clearer to your reader. See the examples below.

Make it Shorter

"Appropriateness is evaluated by the Planning Board and the implementing agency for each specific project depending on community needs, environmental constraints, and right-of-way constraints, with final determination by the County Council."

"The Planning Board and M-NCPPC assess project suitability based on community needs, environmental factors, and land use limitations, with final approval by the County Council."

Make it Clearer

"With the prior written consent of the Planning Board, which is not to be unreasonably withheld, the Planning Board can grant, within 14 days of the application, the developer permission to assign the development agreement."

"The Planning Board may allow the developer to assign the development agreement within 14 days from date the application is filed. The board must give written consent prior to the assignment and cannot withhold consent without reasonable justification."

"The developer may obtain permission from the Planning Board to assign the development agreement within 14 days of the application file date. The Planning Board cannot withhold permission without reasonable justification."

"The Planning Board may allow the developer to assign the development agreement:

  • within 14 days of the application date, and
  • with written board consent prior to the assignment.

The Planning Board cannot unreasonably withhold consent to the assignment."

Remove Excessive Detail, Repetitiveness, and Redundant/Filler Words

"I received and read the email you sent yesterday about the report you're writing for the project. I agree it needs a thorough, close review from someone familiar with your audience." "I received your email about the project report and agree it needs a review from someone familiar with your audience."
"The test revealed conduction activity that was peculiar in nature." "The test revealed peculiar conduction activity."
"Many Metro stations have facilities for bicycle storage. This facilitates riding a bicycle to a station, storing it there, and continuing the trip on Metrorail or Metrobus." "Many Metro stations offer bicycle storage, allowing riders to continue their journey on Metrorail or Metrobus."

Tips:

  • Set word or page limits for your project and adhere to them; this will help you to review your document for the issues described above. If this writing project is periodical, challenge yourself to convey the same amount of information as the previous version in fewer words.
  • This list of unnecessary words will help you to identify the passages that should be shortened.

Create Figures to Help Your Reader

A figure is a chart, table, graph, illustration, or infographic that can convey necessary information using a minimum of written text. Using figures makes your document more concise; it can also make the document less dense by increasing white space.

Would you prefer to read this?

Approximately 77.14 acres is designated retail, 116.16 acres industrial, 2.26 acres mixed used, and 14.08 acres office. The retail uses are concentrated along Bladensburg Road, Kenilworth Avenue, and Annapolis Road. Industrial is concentrated west of Kenilworth Avenue, in the Town of Edmonston. The little mixed use or office uses that exist in the sector plan area is centered in the core near the intersections of Bladensburg Road, Kenilworth Avenue and Annapolis Road. (72 words)

Or this?

Land Use in Port Towns

Use Size (Acres) Concentrated Areas
Retail 77.14 Bladensburg Road, Kenilworth Avenue, Annapolis Road
Industrial 116.6 West of Kenilworth Avenue in Edmonston
Mixed-Use 2.26 In the core near intersection of Bladensburg Road, Kenilworth Avenue, and Annapolis Road
Office 14.08 In the core near intersection of Bladensburg Road, Kenilworth Avenue, and Annapolis Road

(42 words)

The Publications Section can help you with creating figures for your projects or making your existing figures more reader-friendly.