Duncan Kent & Associates Ltd. > Web Publishing

By: Duncan Kent & Assoc  09-12-2011

Most large organizations now want their technical documents online—either on their Internet or intranet site. Much of our current work involves designing Web pages and populating them with information.

The software for producing online documents has been around for years, but for various reasons, few documents were published online. The explosive growth in the use of the Internet and intranets, however, has provided a reliable means of making a broad range of documents accessible to anyone with a Web browser. Many organizations are now using their Internet or intranet site as the primary way of communicating information to their employees, clients, and the public. The corporate library is finally going online.

Advantages of Online Documents

Here are some advantages that online documents have over print documents:

  • They can be updated rapidly, so readers get up-to-date information fast.
  • They can be searched and browsed quickly using the search engine, table of contents, index, or internal cross-references.
  • Printing and distribution costs are reduced or eliminated.

Print or Online or Both?

For many organizations, the question is not whether to produce a print document or an online document, but whether to produce a print document and an online document. Publishing them online doesn’t necessarily mean that you don’t need print copies. In many cases, you’ll need both.

Here’s why you may want both print and online documents:

  • Not all staff use a computer, have easy access to one, or use it often enough to feel comfortable. As a guideline, online documents are only useful for people who regularly use a computer as part of their job.
  • It’s not easy to read an online document on the bus or at home (it’s possible, just not easy).
  • It will cost too much to get everyone linked together, particularly the cost of upgrading hardware and software and the cost of retraining.

Information That Doesn’t Belong Online

Not all information belongs online. Some information is better off in print form. Here are some examples of information that shouldn’t be online:

  • Large amounts of text, such as a textbook, that must be read thoroughly (the monitor is too hard to read for extended periods)
  • Any information intended for people who aren’t regular users of computers
  • Procedural information that will be used away from the desk (such as anything in a field guide)
  • Emergency recovery procedures for recovering from a power failure

The best type of information to go online is quick-reference information—anything that the user will browse or search rather than systematically read. Internal documents, such as policy and procedure or reference manuals, work well online because few people read them for extended periods—they are reference publications.


Other products and services from Duncan Kent & Assoc

09-12-2011

Duncan Kent & Associates Ltd. > Technical Writing

Your technical documents should be appropriate for their intended use, up to date, and easy to read. We’ve been writing technical documents of all types for more than a decade. Establish the information model for your content management system. Convert print documents to your online documents. Software end-user manuals and help systems. Program information for the public.


09-12-2011

Duncan Kent & Associates Ltd. > Document Maintenance - docmaint

We’re available when you need us, and you only pay for the time we’re working on your manuals. Our staff can complement your in-house resources—we’ll work closely with your staff. Update online version of the manual. Write new text and edit changes. Format new and revised sections.


09-12-2011

Duncan Kent & Associates Ltd. > Training Courses and Materials

We have years of experience designing and preparing instructions and training materials for adult learners. We’ve also developed online training materials and facilitated an online university writing course. Design and produce overheads and PowerPoint presentations.


09-12-2011

Duncan Kent & Associates Ltd. > Content Management Systems

CMSs allow organizations to reuse written and graphic information in a variety of documents while still maintaining only one copy of the information, so it’s much easier to keep up to date and is consistent across all your documents and formats.


09-12-2011

Duncan Kent & Associates Ltd. > Document Maintenance - proposals

Proposals typically consist of multiple volumes—the main body describing how the proposed solution meets each of the requirements set out in the RFP and perhaps any factors that provide value over and above the minimum requirements, followed by appendices with supporting technical detail.


09-12-2011

Duncan Kent & Associates Ltd. > Online Forms

Data can be automatically sent to a database where you can manage it, avoiding expensive and time-consuming data entry. Forms are received moments after they are sent, eliminating time delays while forms make their way through the mail. Math functions can be enabled, reducing the number of calculations and the possibility of mistakes. Consider these possibilities for converting your forms into online forms.


09-12-2011

Duncan Kent & Associates Ltd. > Policies and Procedures

Meet ISO 9000 or other industry standards – Quality standards such as ISO 9000, developed by the International Standards Organization, require that all aspects of your operations that influence the quality of your products or services be clearly documented and available to employees.