Developing Information Content for the World Wide Web
With the expanding technical options for communication on the Web, developers might be tempted to focus only on issues such as hypterext markup language (HTML) syntax, page layout, or the latest and flashiest technologies. However, Web developers need a broader, more process-oriented approach in order to articulate the information content they wish to convey. Developers also need to pay close attention to the characteristics and qualities of the Web as a medium for communication so that they don't merely duplicate practices intended for paper or other media.
Developing Web content involves shaping and negotiating meaning and making many choices involving technical, aesthetic, and usability concerns. And, as technical communicators know, developing information requires keen skills in planning, analysis, and design 1 in addition to Web-oriented skills in representing information in a particular medium 2.
In order to develop a broader perspective of Web, developers can draw on many existing concepts from technical communication and software engineering practices. This article briefly describes my methodology 3, 4 for Web information development that is process-oriented and which takes into account the unique characteristics and qualities of the World Wide Web.
An Information Development Methodology for the Web
Patterned after design and development processes similar to those used by many technical communicators1, writers, designers, and software developers 5, this methodology involves six process and six elements. I base this methodology on the characteristics and qualities of the Web and on the particular experiences of Web users.
My methodology involves six sets of information, which I call elements:
- Audience information is a store of knowledge about the target audience for the web as well as the actual audience who uses the web.
- The purpose statement defines the reason for and scope of the web's existence.
- The objectives list defines the specific goals the web should accomplish.
- The domain information is a collection of knowledge and information about the subject domain the web covers.
- The web specification is a detailed description of the constraints and elements that will go into the web.
- The web presentation is the full description of the technical structures (hypertext and other media) by which the web is delivered to the users.
The communicator develops these elements while engaging in these six processes:
- Planning is the process of defining and gathering information about the web's audience, purpose, objectives, and policies for information development and use.
- Analysis involves evaluating information consistency and correctness as well as checking the technical makeup of the web.
- Design is the process of creating a map of the relationships among pages of the web and the look and feel of individual pages.
- Implementation: is the process of creating files of HTML (and associated software, such as Java applets).
- Promotion: involves providing publicity releases for general Web audiences, potential users, and current users.
- Innovation is the process of continuously and creatively working for improvement in the web to meet user needs.
You'll notice that this methodology contains many of the same elements as a traditional information development process as well as shares a resemblance to software engineering practices. However, since Web works often are very dynamic and competitive, a web information developer should work on all these processes continuously. There's no "final state" analogous to a ship date for a paper document, software, or CD-ROM--every day is a new deadline, and each day brings a new information environment.
Planning for the Audience and Purpose
In the first stages of the lifecycle of a web, your focus will be on the processes of planning and analysis. In particular, you'll need to define the purpose of your web and develop audience information. Audience analysis is key in many technical communication tasks 6. This planning and analysis requires that you ask and answer questions such as: Who will use this web? What will they gain from it?
A useful method to generate audience information is to make a list of information about the audience's background, characteristics, and concerns. This information may not ever be complete, but developers can create and maintain a store of information that can grow over time.
At first, don't try to reach too broad an audience (e.g., "everyone using the Web"), but focus on a subset related to your purpose. For example, if you are preparing a web for a company selling modems, you might define your audience as "potential, current, and past purchasers of the modems." You may have several audiences for the web. For example, in addition to modem buyers, you could be also communicating to company stockholders, employees, or suppliers. One useful technique is to create a diagram showing the audiences you will reach in your web.
Another focus in the early phase of web development is to define your purpose. It's a good idea to have a written purpose statement available at all times during web development. At first, you might state the purpose in general terms, such as "to create a presence for our company in cyberspace." However, it is best to make your purpose statement more specific even at first, such as "to provide information about our company's products."
The purpose statement and audience information together go a long way toward articulating what the web is about and are the key pieces of information to develop early in the web's lifecycle.
Setting Objectives and Gathering Domain Information
Given an audience and a purpose, you can next focus on forming a list of specific objectives, or goals, for the web to accomplish. For example, a web's purpose statement might be "to provide information about our company's line of modems" and this web's audience definition might be "prospective customers."
The objective list for this web might be:
- List the pictures, prices, schematics of all of our modems.
- Provide ordering and service information.
- Provide background (domain) information about modems to interest prospective customers and help them user our products.
Once you have created a set of objectives, the next step is to gather domain information that supports these objectives. The domain information is a collection of knowledge and information about the subject domain the web covers. This includes information that the users of the web will encounter and information the web developers need to design or implement the web.
For example, a web offering modems for sale might draw on a variety of information about the use, mechanics, principles, and specifications for modems. While not all this information would necessarily be made available to the users of the web, this domain knowledge may be helpful for the web developers so that they can understand the vocabulary and concepts associated with the products.
Often, this domain information makes a good complement to the information the web offers. For example, a modem manufacturer with a good collection of modem facts might find that interested buyers visit that web for technical information about modems and, in the course of this visit, be informed of a company's products.
Designing a Web
In designing a web you should take into account the web's purpose and audience. A good designer knows how to achieve the effects called for in the most flexible, efficient, and elegant way. To design a web, you should have a thorough grounding in hypertext, multimedia, Java, and other programming possibilities as well as knowledge about how particular web structures affect an audience.
Because of the porous quality of a web, you need to consider how a variety of audiences might find different "ways into" your information. Hypertext can provide alternate views of information and alternative routes for users to follow based on their needs and interests. A good way to provide this flexibility is to separate information into manageable page-sized chunks and then provide cues for the reader about the web's information structure and contents, context, and navigation. A Web designer thus creates an overall link architecture for a web--specifying page contents and the hyperlinks among these pages to connect information along the routes of user needs.
A web designer should also create a coherent and consistent "look and feel" for the entire web. One way to do this is to use principles of page layout and design and provide the user with a variety of visual cues. These cues, consistently placed on pages of the web, help users navigate and use the web's information. Because a web is characteristically bound in its use context, these cues should help reveal that context, so that the user can find related information and find how the web relates to other areas of knowledge.
Implementing a Web
After you've completed a web design, the next step is to implement the web within the limitations on its technical makeup you may have defined in its specifications. The initial implementation might be a prototype which is not released publicly, but available for analysis as used by a set of representative users.
A web implementor creates hypertext markup language (HTML), Common Gateway Interface (CGI) programs, and/or Java scripts and/or applets. The implementation process resembles software development because it involves using a specific syntax for creating hypertext structures in HTML or writing programming language code statements in computer files.
Here are key implementation practices:
- At the outset, create a stable, extendible directory and file structure to manage the web's files and/or software components (including CGI or Java programs).
- Use HTML tools such as editors and authoring environments where helpful. Note that some of these editors are "translators" from authoring programs meant for paper based publications and are not always customized for hypertext development.
- Check the web's implementation in various browsers to ensure that the HTML can be interpreted properly. Use templates for supporting the consistent look and feel defined in the Web's design.
Analyzing a Web
During analysis, you examine a web's elements to see if it is accomplishing its objectives, to see if it is implemented correctly, and its domain information is correct and up-to-date. The goal of this evaluation is to identify problem areas.
Key analysis practices are:
- Observing representative audience members using your web (usability analysis).
- Evaluating the consistency and verify the correctness of the domain information.
- Checking the technical implementation of the web with HTML validation tools.
The Web's Release and Promotion
The decision to publicly announce the release of your web should not be made lightly. During the time immediately following its public availability, your web will receive a great deal of attention from not only the audience members it attempts to reach, but people involved in web resource indexing as well as automated indexing software.
Once your web is ready, you can make its existence known to online communities through publicity. You can also form relationships with other webs which reach a similar audience or have been prepared for a similar purpose. Another way to further promote a web is to use specific marketing strategies or business models customized for the environment of the Web.
In doing this promotion, it is important that you follow online community norms. You should avoid "spamming" (indiscriminately sending messages to large numbers of mostly uninterested people) any communication forum with news of your web's release. Instead, you should aim publicity to appropriate online (and offline) mailing lists and promotion services.
Despite the linear description of the processes of Web development I've described here, the work of a Web is never done. Because a web is a round-the-clock, interactive service, developers should expect feedback from users and anticipate their changing needs.
Key innovation practices are:
- Continuously and creatively work for improvement to meet user needs.
- Based on analysis, user testing, and focus groups, identify new user needs.
- Identify new technologies that may help you meet user needs better.
Ultimately the goal of innovation is to continuously improve the quality of a web by making sure that the processes of planning, analysis, design, implementation, promotion, and innovation are ongoing. Developers can share information about the web's elements and ensure that the information in the web meets user needs in terms of both content and interface.
While the methodology outlined here for developing a web won't work flawlessly in all situations, it can serve as a basis for approaching many of the issues of web information development.
To a casual Web user, this formal methodology might seem an encumbering amount of complication on what may seem to be only the task of "writing HTML" or creating a "home page." However, identifying processes and elements and focusing on them need not stifle creativity--in fact, a process approach is a emphasis of many quality improvement programs 7. And, as many Web users might attest, a well-developed web usually has a far greater value than one that is hastily put together. In particular, a web intended for business or professional communication needs to not only reflect a consensus of meaning among the sponsors and originators of the information, but it must reach a diverse audience and continuously change as user needs change.
- Grice, Roger A. "Document Development in Industry." In Technical Writing: Theory and Practice, ed. Bertie E. Fearing and W. Keats Sparrow, pp. 27-32. New York: The Modern Language Association of America, 1989.
- Nielsen, Jakob. Designing Web Usability. Indianapolis: New Riders, 2000.
- December, John, "An Information Development Methodology for the World Wide Web," Technical Communication, (Vol. 43, No. 4, 1996, pp. 369-375).
- December, John. "Web Development." December Communications, Inc. <https://johndecember.com/web/develop.html>.
- Booch, Grady. Object-oriented analysis and design with applications. Redwood City, CA: Benjamin/Cummings Publishing, 1994.
- Anderson, Paul V. Technical Writing: A Reader-Centered Approach. 2nd ed. San Diego, CA: Harcourt Brace Jovanovich, 1991.
- Deming, W. Edwards. Out of the crisis. Cambridge, MA: MIT Center for Advanced Engineering Study, 1986.
- Designing Web Usability: This is Jakob Nielsen's site on Web usability and provides excellent coverage of Web page layout and design techniques. Dr. Nielsen provides links to his numerous papers and essays concerning usability, including his expertise in heuristic evaluation and usability metrics.
- Usable Web: This site provides a large collection of links about human factors, interface design, and usability issues specific to World Wide Web development. The resources are described, and mutiple organizational schemes allow for searchng by date, site, topic, or popularity. Topics covered include news, usability engineering, design, calendar of events, issues, sources, and technology.