As You Write: Difference between revisions

From Way With Words
Line 1: Line 1:
== Organize Your Content in a Reader-Friendly Way ==
== Organize Your Content in a Reader-Friendly Way ==
* <u>'''Identify Key Questions'''</u>: Anticipate the questions your audience may have about the topic. What will they need to know to have a good understanding of the subject?  
'''Identify Key Questions'''. Anticipate the questions your audience may have about the topic. What will they need to know to have a good understanding of the subject?
* '''<u>Structure Your Draft:</u>''' Arrange your content based on these questions, following the order in which a reader might logically ask them. If appropriate, you may want to:  
 
*# create headings based on the topic to be addressed in that particular section;
 
*# adopt a Q&A format, using the questions as headings to guide your audience through the document; or
'''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:
*# make headings about each topic that form a complete sentence.
* Create headings based on the topic to be addressed in that particular section;
*# create an executive summary (for more formal documents) or explainer notes at the beginning of the document that concisely capture the main conclusions, recommendations, or important insights of your project. This allows the reader to understand the key messages quickly.
* Adopt a Q&A format, using the questions as headings to guide your audience through the document;
* '''<u>Ensure Logical Flow:</u>''' 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.
* Make headings about each topic that form a complete sentence.
* Include a summary (for longer documents) or other explainer notes at the beginning of the document that concisely capture the main conclusions, recommendations, or important insights of your project. This allows the reader to understand the key messages quickly.
 
 
'''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.


== Be Concise ==
== Be Concise ==
Line 20: Line 24:
Remember your target audience. Are you using words that they would be familiar with? Is there a way to express the information in a simpler way that still provides your audience with the information that they need to know?
Remember your target audience. Are you using words that they would be familiar with? Is there a way to express the information in a simpler way that still provides your audience with the information that they need to know?


EXAMPLE:
'''EXAMPLE:'''


<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.
<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.
Line 27: Line 31:


While conciseness is valued, Increasing the chances 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.
While conciseness is valued, Increasing the chances 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.
'''Other ways to increase readability:'''
   ○ '''Create white space''' between paragraphs.
   ○ '''Create white space''' between paragraphs.
   ○ Use bulleted or numbered lists instead of narratives where applicable.
   ○ Use bulleted or numbered lists instead of narratives where applicable.
   ○ Use '''bold''', ''italic'' or <u>underline</u> formatting to emphasize key words or phrases.
   ○ Use '''bold''', ''italic'' or <u>underline</u> formatting to emphasize key words or phrases.
   ○ Create hyperlinks and change the URL to explanatory text
   ○ Create hyperlinks and change the URL to explanatory text
 
'''EXAMPLES:'''
 
 
'''Examples:'''


<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.”
Line 52: Line 55:
==== Would you prefer to read: ====
==== Would you prefer to read: ====


<blockquote> 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 center in the core near the intersections of Bladensburg Road, Kenilworth Avenue and Annapolis Road. '''(72 words)''' </blockquote>
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 center in the core near the intersections of Bladensburg Road, Kenilworth Avenue and Annapolis Road. ''(72 words)''
Or this?
 
'''Or this?'''


{| class="wikitable"
{| class="wikitable"
Line 82: Line 86:
|
|
|}
|}
'''(43 words)'''
''(43 words)''


Do you need help with creating images, tables, charts, or infographics for your project? We can also make existing figures more reader-friendly. [[PPD-Publications@ppd.mncppc.org|Just let us know.]]
Do you need help with creating images, tables, charts, or infographics for your project? We can also make existing figures more reader-friendly. [[PPD-Publications@ppd.mncppc.org|Just let us know.]]


<span style="display: none;">This text will not be displayed.</span>
<span style="display: none;">This text will not be displayed.</span>

Revision as of 17:42, 7 March 2024

Organize Your Content in a Reader-Friendly Way

Identify Key Questions. Anticipate the questions your audience may have about the topic. What will they need to know to have a good understanding of the subject?


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:

  • Create headings based on the topic to be addressed in that particular section;
  • Adopt a Q&A format, using the questions as headings to guide your audience through the document;
  • Make headings about each topic that form a complete sentence.
  • Include a summary (for longer documents) or other explainer notes at the beginning of the document that concisely capture the main conclusions, recommendations, or important insights of your project. This allows the reader to understand the key messages quickly.


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.

Be Concise

Government writing often features wordy and dense sentences, suitable for academic contexts to showcase expertise and nuance, but not for the general public. This bureaucratic style of writing can alienate those not versed in the subject matter and are deterred from engaging with complex, multi-clause sentences that are unclear.

Tips:

  • Set word or page limits for your project and adhere to them - attention spans are short. If this writing project is annual/periodical, try to convey the same amount of information as the previous version in fewer words.
  • Remove unnecessary words. LINK

Increase Readability

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

Remember your target audience. Are you using words that they would be familiar with? Is there a way to express the information in a simpler way that still provides your audience with the information that they need to know?

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."

While conciseness is valued, Increasing the chances 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.

Other ways to increase readability:

Create white space between paragraphs.
 ○ Use bulleted or numbered lists instead of narratives where applicable.
 ○ Use bold, italic or underline formatting to emphasize key words or phrases.
 ○ Create hyperlinks and change the URL to explanatory text

EXAMPLES:

“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 of the application. The board must give written consent prior to the assignment. The board cannot withhold consent without reasonable justification.

The Planning Board may allow the developer to assign the development agreement under the following circumstances:

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

The Planning Board cannot unreasonably withhold consent to the assignment.

Create Figures to Help Your Reader

Find ways to convey the necessary information using a minimum of written text, accompanied by a figure (chart/table/graph/illustration/infographic), which helps with keeping your project concise and increases white space for more readability.

Would you prefer to read:

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 center 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 Centered in the core near intersection of Bladensburg Road, Kenilworth Avenue, and Annapolis Road
Office 14.08 Centered in the core near intersection of Bladensburg Road, Kenilworth Avenue, and Annapolis Road

(43 words)

Do you need help with creating images, tables, charts, or infographics for your project? We can also make existing figures more reader-friendly. Just let us know.

This text will not be displayed.