Tips for writing a paper. Writing for Computer Science Clear Concise Accurate Organised (Logically)
Writing for the Web: Clear and Concise
-
Upload
carlos-delaney -
Category
Documents
-
view
75 -
download
3
description
Transcript of Writing for the Web: Clear and Concise
![Page 1: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/1.jpg)
Writing for the Web: Clear and Concise
Presented by the NYS Forum IT Accessibility Committee
![Page 2: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/2.jpg)
Ground Rules
Cell phones off or on vibrate; no texting or emailing
Participate in workshops Misery is optional Respect your neighbors Clean up after yourself
![Page 3: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/3.jpg)
Objectives
Apply formatting to make information clearer and easier to understand
Recognize and correct problems with: ClarityWordiness
![Page 4: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/4.jpg)
Agenda
Usability research about how users read web pages
Relate that research to classic principles of formatting, writing and readability
Hands-on exercises
![Page 5: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/5.jpg)
To Go From This:
Courtesy of the NYS Tax Department
![Page 6: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/6.jpg)
To This:
Courtesy of the NYS Tax Department
![Page 7: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/7.jpg)
Quick Exercise
![Page 8: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/8.jpg)
Courses Business Science Arts Accounting Chemistry
Performing Marketing Physics Music Finance Biology Dance Economics Fine Photography
Sculpting
![Page 9: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/9.jpg)
Count backwards from 105, by 3’s10510299…..
![Page 10: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/10.jpg)
Courses
ArtsBusiness• Accounting• Marketing• Finance• Economics
• Performing• Music• Dance
Science• Chemistry• Physics• Biology
• Fine• Photography• Sculpting
![Page 11: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/11.jpg)
Content Overload
![Page 12: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/12.jpg)
Grouped Content
![Page 13: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/13.jpg)
Why Clear, Concise Pages Matter
Readers: Are in a hurryMay be juggling a lot of informationDon’t want a lot of proseHave varied reading skillsMay not be native English speakersMay have reading disabilitiesMay use search engines to find information
![Page 14: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/14.jpg)
Results of Vague, Wordy Pages
People misunderstand your content People give up trying to read it Your pages are hard to find in searches Increased calls to your call center
(and more work for you!)
![Page 15: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/15.jpg)
Findings from Usability Studies
Skilled readers: Read at a 10th – 12th grade level Scan web pages for
Headings Keywords Links
First 2 words of a line get most attention “F” pattern
![Page 16: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/16.jpg)
F-pattern Shown in Eye-Tracking Studies
http://www.useit.com/alertbox/reading_pattern.html
![Page 17: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/17.jpg)
Findings from Usability Studies
Unskilled readers: Read at a 6th – 8th grade levelDo NOT scanRead slowly, word by wordGive up if there are too many words
![Page 18: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/18.jpg)
Skilled vs. Unskilled Readers
As web use increases, unskilled readers
are becoming nearly half of all users.
![Page 19: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/19.jpg)
What Do They Have in Common?
Neither wants to read all the text on your web page (and they won’t!)
![Page 20: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/20.jpg)
How to Serve Both at Once?
Most important information first Put key information words at the start of:
Headings Opening sentences List items
Use standard English Use 6th-8th grade reading level
![Page 21: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/21.jpg)
Audience Analysis
Who uses your web site? One group? A mix of several groups?
What are the goals of your users? What are your users’ top tasks? What are your users really looking for?
http://www.usability.org/
![Page 22: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/22.jpg)
Audience Analysis (cont’d)
Your call center can often help you understand your users betterWhat are the most common questions?What confuses people?
![Page 23: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/23.jpg)
Audience Analysis (cont’d)
No call center or helpdesk? Think about what questions you getAsk your colleagues about the questions they
answer most often
![Page 24: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/24.jpg)
Apply Your Audience Analysis:
What is your message? In one sentence, what are you trying to tell people?
Why are you creating a web page? Answering users’ questions Addressing users’ concerns
http://www.usability.org/
![Page 25: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/25.jpg)
Formatting
“Escaping the essay”HeadingsBulleted listsWhite space
![Page 26: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/26.jpg)
Organization
“Top down” Order of importance By task By topic By user group “Rule of 7”
http://www.usability.org/
![Page 27: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/27.jpg)
Alignment and formatting of text
For better readability be consistent with fonts, formatting and alignment:
Left justification is easier to read Center content sparingly Keep paragraphs to approx 12 words in width Sans serif fonts like Arial are easier to read
![Page 28: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/28.jpg)
Emphasizing Content
Don’t emphasize text withALL CAPSUnderlining Italics
Do emphasize text with boldface
![Page 29: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/29.jpg)
Writing Links
Don’t use non-descriptive links:Click here for more informationorFor more information go to https://parole.state.ny.us/EMPLOYrequirements.asp
Do use descriptive links: For more information go to Parole website
![Page 30: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/30.jpg)
Handling acronyms
Don’t use acronyms without explaining what they mean
Do spell out acronyms (i.e., Empire State College (ESC) )
![Page 31: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/31.jpg)
Use of images
Be careful not to overuse images Align images with your message Moving images may not comply with
accessibility standards
![Page 32: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/32.jpg)
Use of images (cont’d)
Images can be broken down into the following: Illustration Navigation Decoration
![Page 33: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/33.jpg)
Content Overload
![Page 34: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/34.jpg)
Content That’s “Just Right”
![Page 35: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/35.jpg)
Workshop #1 – Part 1
“Escaping the essay”: 15 Minutes
![Page 36: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/36.jpg)
Go From This:
![Page 37: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/37.jpg)
To This:
![Page 38: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/38.jpg)
Formatting: Questions?
![Page 39: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/39.jpg)
Break! 15 Minutes
![Page 40: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/40.jpg)
“Readability Formulas”?
Common formulas:Fogg IndexFlesch-Kincaid
Formulas are based on:Average sentence lengthSyllable countRatios of short to long words
![Page 41: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/41.jpg)
The Flesch-Kincaid Formula
![Page 42: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/42.jpg)
What’s NOT Measured?
Use of standard English Appropriateness for audience Logical flow Organization Format And many other features!
![Page 43: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/43.jpg)
So What Good Are Formulas?
Emphasis on sentence length highlights:WordinessOverly complex sentences
Emphasis on syllable count, use of long vs. short words highlights:Overuse of long, unfamiliar, “$4” words
![Page 44: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/44.jpg)
So How Do You Make a Web Page More “Readable”?
Organization and formatting Avoid the “wall o’ text”
Clarity Conciseness Use conversational language (e.g. You, we ...) All of the above based on your audiences!
![Page 45: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/45.jpg)
Editing for “Clarity”
What does “clear” mean?Can only be interpreted one way
Concrete and specific Make sentences “active” (a.k.a. active voice)
![Page 46: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/46.jpg)
Concrete and Specific
Abstract Concrete
Food
Transportation Motor Vehicle Truck
Fruit Pear Bartlett
![Page 47: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/47.jpg)
Active Sentences
Working definition:
or said another way:
Action in the verb, agent in the subject
The subject does the action in the verb.
![Page 48: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/48.jpg)
How to Make a Sentence “Active”?
Find the action Make the action the verb Figure out who or what is doing the action
(a.k.a. the “agent”) Make the agent the subject
![Page 49: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/49.jpg)
Make the Sentence “Active”Where’s the action?
There was an assessment of the
project by the engineers.
Action got hidden inside a noun
![Page 50: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/50.jpg)
Make the Sentence “Active”Where’s the “agent” that does the action?
There was an assessment of the
project by the engineers.
Buried in a phrase at the end
![Page 51: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/51.jpg)
Make the Sentence “Active”
AGENT ACTION OBJECT
The engineers assessed the project.
SUBJECT VERB OBJECT
![Page 52: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/52.jpg)
Make the Sentence “Active”
There was an engineering project
assessment.
Where’s the action?
Buried in words jammed together at the end
![Page 53: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/53.jpg)
Make the Sentence “Active”
There was an engineering project
assessment.
Where’s the agent that does the action?
Buried in those same jammed words – maybe!
![Page 54: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/54.jpg)
Make the Sentence “Active”
AGENT ACTION OBJECT
SUBJECT VERB OBJECT
Inspectors assessed the engineering project.
The engineers assessed the project.
![Page 55: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/55.jpg)
Make the Sentence “Active”
The project was assessed by the
engineers.
Where’s the action?
Buried in a past participle – “passive voice”
![Page 56: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/56.jpg)
Make the Sentence “Active”
The project was assessed by the
engineers.
Where’s the agent?
Buried in a phrase at the end
![Page 57: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/57.jpg)
Make the Sentence “Active”
AGENT ACTION OBJECT
The engineers assessed the project.
SUBJECT VERB OBJECT
![Page 58: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/58.jpg)
Active Sentences Are “Clearer” Because:
Their “subject-verb-object” structure: Is directSpells out who did what, to what
They’re easier for unskilled readers
![Page 59: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/59.jpg)
Workshop #2Editing for Clarity: 20 Minutes
![Page 60: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/60.jpg)
Editing for Conciseness
Classic problems to eliminate: RedundanceMeaningless modifiersPompous diction (“writing to impress”)Phrases for words
![Page 61: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/61.jpg)
Redundance
The evaluators will give active thought
and consideration to the true facts
about the situation.
The evaluators will consider the facts about
the situation.
![Page 62: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/62.jpg)
Redundance
In my personal opinion In my opinion
Small in size Small
Completely accurate Accurate
![Page 63: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/63.jpg)
Meaningless Modifiers
Basically, the general proposals for
balancing the budget were utterly rejected.
The proposals for balancing the budget were
rejected.
![Page 64: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/64.jpg)
Meaningless Modifiers
Perfectly clear Clear
Essentially true True
Very unique Unique
![Page 65: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/65.jpg)
Pompous Diction
It is incumbent on all of us to endeavor to maximize our utilization of best web programming and content development practices
We should use the best practices for web programming and content development.
![Page 66: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/66.jpg)
Pompous Diction
Expeditious Quick
Remuneration Payment
Prevaricate Evade
Utilize Use
![Page 67: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/67.jpg)
Phrases for Words
At this point in time, veterans can apply for
educational benefits with a minimum of effort.
Now veterans can apply for educational benefits easily.
![Page 68: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/68.jpg)
Phrases for Words
In point of fact In fact
Period of time Time (or period)
In order to To
![Page 69: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/69.jpg)
Workshop #3
Editing for Conciseness: 20 Minutes
![Page 70: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/70.jpg)
Did Your Edits Help?
Usability tests Ask some typical users to review content Call center (before and after):
Are they getting the same questions? More? Less? Different?
![Page 71: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/71.jpg)
Summary
Bring information forward with:HeadingsBulletsWhitespaceAnd other “escapes from the essay”
Keep language:“Clear”: Direct, active, specificConcise
![Page 72: Writing for the Web: Clear and Concise](https://reader033.fdocuments.us/reader033/viewer/2022061605/56812c68550346895d90fde9/html5/thumbnails/72.jpg)
References and All Materials
Posted online at:http://www.nysforum.org/accessibility/resources/
(and the URL is on your handouts!)