Skip to content

Commit

Permalink
DIGITAL-27: Remove extra Intro to Accessibility node and replace body…
Browse files Browse the repository at this point in the history
… with source.
  • Loading branch information
cathybaptista committed Oct 28, 2024
1 parent d9c735c commit c9fc1ac
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 42 deletions.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ default:
value: false
body:
-
value: '<p>On the web, people are in a hurry. They skim and scan, looking for fast answers to their questions, so it’s important to get to the point&amp;mdash;quickly!</p><p>&nbsp;</p><p>Help your readers complete their tasks with these Plain Language writing tips:</p><p>&nbsp;</p><p>&lt;table style="width: 100%" border="1"&gt;</p><p><span>&nbsp; </span>&lt;tr&gt;</p><p><span>&nbsp; &nbsp;&nbsp;</span>&lt;td&gt;&lt;strong&gt;Audience&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;Write for your reader. Don&amp;#8217;t write for the experts, the lawyers, or your management, unless they are your intended audience.&lt;/td&gt;</p><p><span>&nbsp; </span>&lt;/tr&gt;</p><p><span>&nbsp;</span></p><p><span>&nbsp; </span>&lt;tr&gt;</p><p><span>&nbsp; &nbsp;&nbsp;</span>&lt;td&gt;&lt;strong&gt;Length&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;&lt;s&gt;Less is more!&lt;/s&gt; &lt;s&gt;Be concise.&lt;/s&gt; Eliminate ALL unnecessary words. &lt;s&gt;Challenge every word = do you need it?&lt;/s&gt;&lt;/td&gt;</p><p><span>&nbsp; </span>&lt;/tr&gt;</p><p><span>&nbsp;</span></p><p><span>&nbsp; </span>&lt;tr&gt;</p><p><span>&nbsp; &nbsp;&nbsp;</span>&lt;td&gt;&lt;strong&gt;Tone&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;Use conversational pronouns (you, us, our, we). Write as if you were talking to a colleague or friend. Use contractions (we’re instead of we are).&lt;/td&gt;</p><p><span>&nbsp; </span>&lt;/tr&gt;</p><p><span>&nbsp;</span></p><p><span>&nbsp; </span>&lt;tr&gt;</p><p><span>&nbsp; &nbsp;&nbsp;</span>&lt;td&gt;&lt;strong&gt;Voice&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;Use active voice with strong verbs. Say “We mailed your form on May 1” instead of “Your form was mailed by us on May 1.”&lt;/td&gt;</p><p><span>&nbsp; </span>&lt;/tr&gt;</p><p><span>&nbsp;</span></p><p><span>&nbsp; </span>&lt;tr&gt;</p><p><span>&nbsp; &nbsp;&nbsp;</span>&lt;td&gt;&lt;strong&gt;Word Choice&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;Use the same words your readers use when they search for your info on the Web. Avoid acronyms and jargon.&lt;/td&gt;</p><p><span>&nbsp; </span>&lt;/tr&gt;</p><p><span>&nbsp;</span></p><p><span>&nbsp; </span>&lt;tr&gt;</p><p><span>&nbsp; &nbsp;&nbsp;</span>&lt;td&gt;&lt;strong&gt;Simplify&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;Use simple, descriptive section headings; short paragraphs; and ordinary, familiar words.&lt;/td&gt;</p><p><span>&nbsp; </span>&lt;/tr&gt;</p><p><span>&nbsp;</span></p><p><span>&nbsp; </span>&lt;tr&gt;</p><p><span>&nbsp; &nbsp;&nbsp;</span>&lt;td&gt;&lt;strong&gt;Links&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;Never use &amp;#8220;click here&amp;#8221;—link language should describe what your reader will get if they click that link. Include key words to help search engines.&lt;/td&gt;</p><p><span>&nbsp; </span>&lt;/tr&gt;</p><p><span>&nbsp;</span></p><p><span>&nbsp; </span>&lt;tr&gt;</p><p><span>&nbsp; &nbsp;&nbsp;</span>&lt;td&gt;&lt;strong&gt;Organization&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;Put the most important information first, followed by the details.&lt;/td&gt;</p><p><span>&nbsp; </span>&lt;/tr&gt;</p><p><span>&nbsp;</span></p><p><span>&nbsp; </span>&lt;tr&gt;</p><p><span>&nbsp; &nbsp;&nbsp;</span>&lt;td&gt;&lt;strong&gt;Improve Tasks&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;Organize content around your customers’ tasks, not your organization. Highlight action items (step 1, step 2, etc.).&lt;/td&gt;</p><p><span>&nbsp; </span>&lt;/tr&gt;</p><p><span>&nbsp;</span></p><p><span>&nbsp; </span>&lt;tr&gt;</p><p><span>&nbsp; &nbsp;&nbsp;</span>&lt;td&gt;&lt;strong&gt;Scannability&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;Separate content into small chunks. Use lots of white space for easy scanning. In general, write no more than 5-7 lines per paragraph. Use lists and bullets, they are easy to scan.&lt;/td&gt;</p><p><span>&nbsp; </span>&lt;/tr&gt;</p><p><span>&nbsp;</span></p><p><span>&nbsp; </span>&lt;tr&gt;</p><p><span>&nbsp; &nbsp;&nbsp;</span>&lt;td&gt;&lt;strong&gt;Separate Topics&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;Present each topic separately. Keep the information on each page to three (or fewer) levels.&lt;/td&gt;</p><p><span>&nbsp; </span>&lt;/tr&gt;</p><p><span>&nbsp;</span></p><p><span>&nbsp; </span>&lt;tr&gt;</p><p><span>&nbsp; &nbsp;&nbsp;</span>&lt;td&gt;&lt;strong&gt;Context&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;Don’t assume your readers already know the subject or have read related pages. Each page should stand on its own. Put everything in context.&lt;/td&gt;</p><p><span>&nbsp; </span>&lt;/tr&gt;</p><p><span>&nbsp;</span></p><p><span>&nbsp; </span>&lt;tr&gt;</p><p><span>&nbsp; &nbsp;&nbsp;</span>&lt;td&gt;&lt;strong&gt;Test and Evaluate&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;Test Web pages with actual customers so you can be sure real people can understand what you write.&lt;/td&gt;</p><p><span>&nbsp; </span>&lt;/tr&gt;</p><p><span>&nbsp;</span></p><p><span>&nbsp; </span>&lt;tr&gt;</p><p><span>&nbsp; &nbsp;&nbsp;</span>&lt;td&gt;&lt;strong&gt;Train&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;Encourage all your colleagues (lawyers, accountants, researchers, etc.) to use plain language—because all content is potentially Web content.&lt;/td&gt;</p><p><span>&nbsp; </span>&lt;/tr&gt;</p><p>&lt;/table&gt;</p><p>&nbsp;</p><p>{{&lt; button href="https://s3.amazonaws.com/digitalgov/_legacy-img/2013/11/checklist-for-Plain-Language-Web-writing.docx" text="Download Checklist" &gt;}}</p>'
value: '<p>On the web, people are in a hurry. They skim and scan, looking for fast answers to their questions, so it’s important to get to the point—quickly! Help your readers complete their tasks with these Plain Language writing tips:</p><table style="width:100%;" border="1"><tbody><tr><td><p><strong>Audience</strong></p></td><td><p>Write for your reader. Don’t write for the experts, the lawyers, or your management, unless they are your intended audience.</p></td></tr><tr><td><p><strong>Length</strong></p></td><td><p><s>Less is more!</s> <s>Be concise.</s> Eliminate ALL unnecessary words. <s>Challenge every word = do you need it?</s></p></td></tr><tr><td><p><strong>Tone</strong></p></td><td><p>Use conversational pronouns (you, us, our, we). Write as if you were talking to a colleague or friend. Use contractions (we’re instead of we are).</p></td></tr><tr><td><p><strong>Voice</strong></p></td><td><p>Use active voice with strong verbs. Say “We mailed your form on May 1” instead of “Your form was mailed by us on May 1.”</p></td></tr><tr><td><p><strong>Word Choice</strong></p></td><td><p>Use the same words your readers use when they search for your info on the Web. Avoid acronyms and jargon.</p></td></tr><tr><td><p><strong>Simplify</strong></p></td><td><p>Use simple, descriptive section headings; short paragraphs; and ordinary, familiar words.</p></td></tr><tr><td><p><strong>Links</strong></p></td><td><p>Never use “click here”—link language should describe what your reader will get if they click that link. Include key words to help search engines.</p></td></tr><tr><td><p><strong>Organization</strong></p></td><td><p>Put the most important information first, followed by the details.</p></td></tr><tr><td><p><strong>Improve Tasks</strong></p></td><td><p>Organize content around your customers’ tasks, not your organization. Highlight action items (step 1, step 2, etc.).</p></td></tr><tr><td><p><strong>Scannability</strong></p></td><td><p>Separate content into small chunks. Use lots of white space for easy scanning. In general, write no more than 5-7 lines per paragraph. Use lists and bullets, they are easy to scan.</p></td></tr><tr><td><p><strong>Separate Topics</strong></p></td><td><p>Present each topic separately. Keep the information on each page to three (or fewer) levels.</p></td></tr><tr><td><p><strong>Context</strong></p></td><td><p>Don’t assume your readers already know the subject or have read related pages. Each page should stand on its own. Put everything in context.</p></td></tr><tr><td><p><strong>Test and Evaluate</strong></p></td><td><p>Test Web pages with actual customers so you can be sure real people can understand what you write.</p></td></tr><tr><td><p><strong>Train</strong></p></td><td><p>Encourage all your colleagues (lawyers, accountants, researchers, etc.) to use plain language—because all content is potentially Web content.</p></td></tr></tbody></table>'
format: html
summary: ''
field_summary:
Expand Down

0 comments on commit c9fc1ac

Please sign in to comment.