Writing For The Web - Part Three

by omega 2/1/2008 12:40:00 AM
 Navigation

Navigating a web document differs from navigating the Web. A web document fits within one or more web pages and covers a focused topic. The web page is the unit displayed to the user and can contain one or more web documents (as well as other web elements).

NAVIGATING DOCUMENTS

When writing a document for the Web, use links to guide the reader through the document. Think of "linking" as the quickest means to get the user to the most relevant information. Whenever possible, state conclusions and link to supporting details; enumerate categories and link to lists; summarize and link to full-length treatments. This allows the user to scan the contents of a page and select relevant and useful information.

Links embedded in a document are the primary links that you want a reader to see; since readers use links as guideposts in scanning, you want to use them correctly and write in a way that takes best advantage of them. Only the most pertinent should be "part" of the document. Don't let links become a distraction. Position less relevant, but meaningful links of additional information in the web page's margin or at the end of the document under a "See Also" label.

NAVIGATING THE WEB

If a link takes the user "outside" the document, then its purpose is to navigate the Web site (or direct the reader to a third-party web site). Whenever possible, links such as these should guide the user to additional information that is directly connected--not only to the topic of the document, but to the topic of the paragraph or section being read.

Writing to be Read

Heads:

Make the topmost head on the page an H1, worded so that the user knows why the page is important.

Make sure that heads clearly indicate the content of the sections.

Avoid in-line character formatting to heads--the results are unpredictable, varying from browser to browser.

Organize your text so that the hierarchy is no deeper than four levels. Lower-level heads are hard to distinguish and disorienting to online readers.

Lists:

You can include a greater number of lists on a web page than on a printed paper page.

Use numbered lists when the order of entries is important.

Use unnumbered lists whenever the sequence of the entries is not important.

Limit the number of items in a single list to no more than nine.

Generally, limit lists to no more than two levels: primary and secondary.

Captions:

Make sure that the caption uniquely identifies the illustration or table. For example, do not give the same name to the caption as you have given to a head on the same page or another page.

Caption illustrations except when the context is so clear that captions would be redundant.

Don't number illustrations sequentially by chapter, section, or the like. If a screen capture has more than one illustration to which you must refer, use a simple numbering scheme (Figure 1, Figure 2). If you follow the "one topic per screen" guideline, however, figure numbers usually won't be necessary.

Don't include figure captions unless you need them or have a lot of conceptual or reference material.

Hyperlinks:

Don't use a hypertext link if the information can be succinctly presented on the current page.

Don't mention that you are providing links at all.

Use a description of the information to be found in the link, or perhaps the link address.

Use hyperlinks to provide supplemental information like definitions of terms and abbreviations, reference information, and background reading.

Cluster cross-references under a "See also" (or similar) heading where appropriate. Generally, such lists of cross-references are easiest to read if they include only headings or titles with a few words of explanation.
NOTE: The left navigation bar on www.sun.com correctly lists cross-references with no explanatory text.

Copyright 1994-2008 Sun Microsystems, Inc.

 

Ω

 

Related posts

Add comment


 

  Country flag





Live preview

12/1/2008 10:44:07 AM

Powered by BlogEngine.NET 1.2.0.0
Theme by Mads Kristensen

About the authors

Omega

Weblogs are posted by various employees of Omega Web Solution, and are for informational purposes only.

Any copyrighted materials posted are listed as such and include original copyright information and sources.

E-mail me Send mail

Calendar

<<  December 2008  >>
MoTuWeThFrSaSu
24252627282930
1234567
891011121314
15161718192021
22232425262728
2930311234

View posts in large calendar

Pages

    Recent comments

      Authors

      Disclaimer

      Weblogs are posted by various employees of Omega Web Solution, and are for informational purposes only.

      © Copyright 2008 omega Web Solution

      Sign in