{"id":161,"date":"2009-12-02T13:03:21","date_gmt":"2009-12-02T12:03:21","guid":{"rendered":"http:\/\/blogs.oucs.ox.ac.uk\/adamweblearn\/?p=161"},"modified":"2021-03-31T09:50:10","modified_gmt":"2021-03-31T08:50:10","slug":"writing-for-the-web-tips-2","status":"publish","type":"post","link":"https:\/\/blogs-new.it.ox.ac.uk\/adamweblearn\/2009\/12\/writing-for-the-web-tips-2\/","title":{"rendered":"Writing for the Web &#8211; tips 2"},"content":{"rendered":"<p>I attended an ITLP Writing for the Web course in OUCS yesterday and thought I&#8217;d share some tips I picked up.<\/p>\n<p>Before you start your web page or website you should do the following:<\/p>\n<ol>\n<li>clarify the objective &#8211; write this in one sentence<\/li>\n<li>clarify the audience<\/li>\n<li>gather relevant information<\/li>\n<li>think about the structure<\/li>\n<\/ol>\n<p>When writing material<\/p>\n<ul>\n<li>the first paragraph on a page needs to be the conclusion; this is the opposite way around to &#8216;normal&#8217; writing &#8211; the attention span of readers on the web is low, you need to snare them and reel them in straight away otherwise the message is lost<\/li>\n<li>the first sentence of a paragraph should say what the paragraph is about (see above)<\/li>\n<li>make your page <strong>scannable<\/strong>:\n<ul>\n<li>use <strong>highlighting <\/strong>for key issues but don&#8217;t overdo it, readers often only scan the headings, highlighted text and hyper-links<\/li>\n<li>use <strong>bullet-point lists<\/strong><\/li>\n<li>make it <strong>concise <\/strong>&#8211; web readers have less patience\n<ul>\n<li>keep it short &#8211; 15-20 words per sentence<\/li>\n<li>keep it simple<\/li>\n<li>cut the waffle<\/li>\n<li>focus on the action &#8211; use active voice not passive voice: &#8220;dog bit man&#8221; is active &#8220;man was bitten by dog&#8221; is passive<\/li>\n<li>focus on the reader &#8211; use appropriate language, be positive, remove all ambiguity<\/li>\n<li>get it right &#8211; use correct punctuation and spelling, this gives the reader confidence<\/li>\n<li>make it look good &#8211; use images, subtle use of colour, use sans serif fonts\n<ul>\n<li>when using the WYSIWYG HTML editor in WebLearn always start a page from a template (click the <img loading=\"lazy\" decoding=\"async\" class=\"alignnone\" src=\"https:\/\/weblearn.ox.ac.uk\/access\/content\/public\/help\/fckedit\/images\/fck-template.jpg\" alt=\"\" width=\"13\" height=\"15\" \/> button)<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<li>use meaningful and correctly nested <strong>headings<\/strong> (this is also very important for accessibility)\n<ul>\n<li>the first two words of a heading are the most important: use &#8220;Diana killed in car crash&#8221; not &#8220;Car crash kills Diana&#8221;<\/li>\n<li>use content specific words at the start of a heading: use &#8220;Hurricanes &#8211; general information&#8221; not &#8220;General information about hurricanes&#8221;<\/li>\n<\/ul>\n<\/li>\n<li>have <strong>one idea<\/strong> per paragraph<\/li>\n<li>have <strong>2-3 sentences per paragraph<\/strong><\/li>\n<li>put the<strong> conclusion first <\/strong>&#8211; make it concise<strong><br \/>\n<\/strong><\/li>\n<\/ul>\n<\/li>\n<li>make your pages accessible (this is a legal requirement for educational material)<\/li>\n<li>use consistent terminology<\/li>\n<li>think about what the reader needs to know not what you want to tell them<\/li>\n<li>use browser plug-ins to help authoring (or develop the text in Word first but remember to take care when pasting into a WYSIWYG HTML editor &#8211; see below)<\/li>\n<li>if you are developing a series of pages then make sure navigation is included, Dreamweaver will help you do this; breadcrumb menus help here\n<ul>\n<li>use spell check and grammar check<\/li>\n<\/ul>\n<ul>\n<li>Usability guru Jakob Neilson&#8217;s <a href=\"http:\/\/useit.com\/\">http:\/\/useit.com\/<\/a> website<\/li>\n<li>ITLP courses<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2>Using Word to Author text<\/h2>\n<p>It is a good idea to prepare your text in Word but<strong> do not paste this directly into a WYSIWYG HTML editor<\/strong>, if you do this the resultant web page will be a complete dogs breakfast with all sorts of unwanted mark-up being stored behind the scenes.<\/p>\n<p>When using Word:<\/p>\n<ul>\n<li>use the spell check and grammar check<\/li>\n<li>use Tools &gt; Options &gt; Spelling &gt; Readability Statistics to report on use of passive voice<\/li>\n<li>don&#8217;t worry about highlighting, formatting and layout<\/li>\n<li>copy the text with a mouse and post into a plain text editor such as <strong>Notepad<\/strong><\/li>\n<li>copy the text from <strong>Notepad <\/strong>and paste into the WYSIWYG HTML editor<strong> &#8211;<\/strong> this will remove all the garbage that Word inserts behind the scenes<\/li>\n<li>format the text in the WYSIWYG HTML editor<\/li>\n<\/ul>\n<h2>Useful links<\/h2>\n<h3>Usability<\/h3>\n<ul>\n<li>Visit &#8216;Usability Guru&#8217; Jakob Neilson\u2019s <a href=\"http:\/\/useit.com\/\">http:\/\/useit.com\/<\/a> website<\/li>\n<li>Visit <a href=\"http:\/\/usability.gov\/\">http:\/\/usability.gov\/<\/a><\/li>\n<\/ul>\n<h3>Style Guide<\/h3>\n<ul>\n<li>refer to the <a href=\"http:\/\/www.ox.ac.uk\/document.rm?id=1035\">University&#8217;s style guide<\/a><\/li>\n<\/ul>\n<h3>Accessibility<\/h3>\n<ul>\n<li><a href=\"http:\/\/www.opsi.gov.uk\/ACTS\/acts2001\/ukpga_20010010_en_1\">Special Needs And Disability Act (SENDA)<\/a><\/li>\n<li><a href=\"http:\/\/www.w3.org\/WAI\/\">Web Accessibility Initiative (WAI)<\/a><\/li>\n<li><a href=\"http:\/\/www.w3c.org\/TR\/WCAG\">Web Content Accessibility Guidelines (WCAG)<\/a><\/li>\n<\/ul>\n<h3>Grammar and Spelling etc.<\/h3>\n<ul>\n<li><a href=\"http:\/\/www.editcentral.com\/gwt1\/EditCentral.html\">http:\/\/www.editcentral.com\/gwt1\/EditCentral.html<\/a><\/li>\n<li>use the <a href=\"http:\/\/www.oed.com\/\">Oxford English Dictionary<\/a> &#8211; the University has a subscription<\/li>\n<li>read <a href=\"http:\/\/www.amazon.co.uk\/Eats-Shoots-Leaves-Lynne-Truss\/dp\/0007329067\/ref=sr_1_1?ie=UTF8&amp;s=books&amp;qid=1259762200&amp;sr=1-1\">&#8220;Eats Shoots and Leaves&#8221; by Lynne Truss<\/a><\/li>\n<li>read <a href=\"http:\/\/www.amazon.co.uk\/Rediscover-Grammar-Prof-David-Crystal\/dp\/0582848628\/ref=sr_1_1?ie=UTF8&amp;s=books&amp;qid=1259762163&amp;sr=8-1\">&#8220;Rediscover Grammar&#8221; by David Crystal<\/a><\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>I attended an ITLP Writing for the Web course in OUCS yesterday and thought I&#8217;d share some tips I picked up. Before you start your web page or website you should do the following: clarify the objective &#8211; write this &hellip; <a href=\"https:\/\/blogs-new.it.ox.ac.uk\/adamweblearn\/2009\/12\/writing-for-the-web-tips-2\/\">Continue reading <span class=\"meta-nav\">&rarr;<\/span><\/a><\/p>\n","protected":false},"author":13,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[117,295,105],"tags":[40503,206],"class_list":["post-161","post","type-post","status-publish","format-standard","hentry","category-accessibility","category-web","category-weblearn","tag-accessibility","tag-content"],"_links":{"self":[{"href":"https:\/\/blogs-new.it.ox.ac.uk\/adamweblearn\/wp-json\/wp\/v2\/posts\/161","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blogs-new.it.ox.ac.uk\/adamweblearn\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs-new.it.ox.ac.uk\/adamweblearn\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs-new.it.ox.ac.uk\/adamweblearn\/wp-json\/wp\/v2\/users\/13"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs-new.it.ox.ac.uk\/adamweblearn\/wp-json\/wp\/v2\/comments?post=161"}],"version-history":[{"count":18,"href":"https:\/\/blogs-new.it.ox.ac.uk\/adamweblearn\/wp-json\/wp\/v2\/posts\/161\/revisions"}],"predecessor-version":[{"id":6413,"href":"https:\/\/blogs-new.it.ox.ac.uk\/adamweblearn\/wp-json\/wp\/v2\/posts\/161\/revisions\/6413"}],"wp:attachment":[{"href":"https:\/\/blogs-new.it.ox.ac.uk\/adamweblearn\/wp-json\/wp\/v2\/media?parent=161"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs-new.it.ox.ac.uk\/adamweblearn\/wp-json\/wp\/v2\/categories?post=161"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs-new.it.ox.ac.uk\/adamweblearn\/wp-json\/wp\/v2\/tags?post=161"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}