ThePlace

Home ] Search ] Resources ] Site Map ] Contact Me ]
Dave's Information Technology Resource

Up ]

--- Writing for the Web ---

 

Web Writing Practices

If you look at various web sites, you will find a broad range of writing styles, the following describe some of the more common types of web writing:

bullet"Shovelware" - text is ported directly from print products to the web page.
bullet"Minimalist" - simple, very short bullets.
bullet"Traditional" - writing is similar to that found in print publications.
bullet "Graphic" - extensive use of pictures and icons to tell the story.
bullet "Link/Text" - pages filled with links leading to pages with text.
bullet"Popup" - text with links to popup windows to define, clarify, etc..

Guidelines for Writing for the Web (from Jakob Nielsen)

bulletBe brief and succinct: web content should be 50% of the text for a print publication.
bulletScannability: avoid long continuous blocks of text; use short paragraphs, bullets, and subheadings.
bulletUse hypertext: break up long sets of information into page sections (via bookmark tags) or into multiple pages.
bulletMake your point in the beginning: use the first sentence (and even the first words) to make a point.
bulletUse plain language: be careful with metaphors (not everyone understands); be careful with humor (not everyone gets it); avoid pretentious and high-brow language (boring at a minimum, insulting for everyone else).
bulletUse headlines and titles to break up the page and bring focus to key points in the information.
bulletAvoid abbreviations, initials, and acronyms unless you explain them; the first use of an acronym should always have the meaning spelled out.

Other more obvious guidelines...

bulletUse a spell checker - 'nuff said (okay, enough said).
bulletUse a clean, simple writing style.
bulletProofread everything at least twice, then again for good measure.
bulletHave others read your writing - be open to their opinions (i.e., encourage, accept, and use constructive criticism).
bulletAvoid all caps or all lower case.
bulletAvoid spaces to break up letters in words.

Exceptions to Guidelines

There are always reasons to not do what is recommended -- when you do, you should have a good reason, for example:

bulletIf publishing text in the original source - don't rewrite unless you have a good reason (although summaries can be useful).
bulletBe careful when adding scannability elements to original source.
bulletWhen publishing to the web for "printing" (i.e., the intent is for the material to be printed rather than read), then skipping the above guidelines may be appropriate.

A General Strategy for Writing

bulletPut most important point first.
bulletMain points should lead (first paragraph, first sentence, even first word).
bulletUse bullets to break up points.

Steps for good writing (for the web anyway)...

If you are starting with source materials (e.g., pamphlets, brochures, memos, etc.)...

bulletDecompose the source material by separating the material into chunks or objects that can be individually examined.  You are looking for:
bulletKey points
bulletIdeas
bulletMessage
bulletInformation chunks will tend to be:
bulletMutually exclusive (they stand alone).
bulletCollectively exhaustive in that they should cover everything important of the total point.
bulletExamine and evaluate the information chunks.
bulletEliminate irrelevant materials.
bulletLook for redundancy.
bulletDetermine the relationships or overall structure of the information in terms of:
bulletNetwork or hierarchical relationships (e.g., top-down).
bulletSequential relationships (time)
bulletGeographic or spatial relationships.
bulletConcept maps can be used to illustrate relationships and make them easy to follow.

If you are starting from scratch...

bulletStart writing/rewriting the new web material...consider two perspectives:
  1. Effectiveness: the material must be accurate and complete.
  2. Affectiveness: the material "works" at an emotional level.
bulletUse a checklist to assess your writing:
  1. Completeness - covers all aspects of the idea or message.
  2. Comprehensiveness - covers aspects to the appropriate depth of detail.
  3. Easy to read - simple, uncomplicated sentence structure.
  4. Clear - the material can only be read one way, avoid material that can interpreted differently.
  5. Useful to the intended audience - those who are the targets of the information, get the message AND find it useful.
  6. Succinct and to the point - short, concise and to the point. 
bulletRe-evaluate what you have written:
bulletCompare with the original source material - does it hold up?
bulletConsider the effectiveness and affectiveness - is it?
bulletWere writing goals achieved?
bulletRewrite until it is where you want it.

 

Home ] Up ] Computer Architecture ] Programming Bootcamp ] Database Bootcamp ] Visual BasicS ] Web Basics ] Web Multimedia ] Web Programming ] Advanced Web Topics ] Developing Web Sites ] XML Technology ] Web Glossary ]

Copyright © 1999 - 2005 
ThePlace - Written and Sponsored by Dave Hillman