Hands-on XML and Round Trip HTML for Technical Communicators  

XML can simplify production of documents for print, help and web delivery. It can make document components reusable, portable between platforms and easier to maintain. XML also has a dark side. Parts of the standard are turbulent, vendors are rushing XML products to market that are not fully standard-compliant, implementation requires careful planning, and porting of legacy documents to XML is not trivial. Technical communicators can prosper by identifying the parts of XML that can be implemented immediately, by preparing documents to exploit support for XML available in new versions of Microsoft Word and Adobe FrameMaker, and by using hybrid HTML/XML for document delivery.

Reichman, Katriel. STC Proceedings (1999). Articles>Content Management>Single Sourcing>XML

Hit the Bull's Eye with Targeted Information  

Four years ago, the Publications department at J.D. Edwards was challenged with delivering documentation for a global customer base in both print and on-line media. Based on the principle, 'Write it once, use it many times,' they developed a single repository that contained information about 38 multiple-platform software products translated into seven languages. By managing each paragraph of information through a relational data manager, J.D. Edwards has leveraged this database to deliver user guides, training manuals, on-line helps, and CD-ROMs that provide users with targeted software information that is both high yield and just in time.

Uhl, Cyndi. STC Proceedings (1998). Articles>Content Management>Single Sourcing

How I Survived XML Single Sourcing  

In Ontario Systems’ applications, customers can install various components and can change the user interface and data storage. Further, they can modify the system’s automated work flow and add custom features. To remain accurate, Ontario Systems’ documentation must dynamically change to reflect the changing application configuration. This session discusses how Ontario Systems implemented an XML-based single source system to create dynamic documentation and provides guidelines on this process.

Cantrell, Charles and Ann Rockley. STC Proceedings (2001). Articles>Content Management>Single Sourcing

How to Write Information So You Can Use It Again

You have written a user’s manual for Microsoft Word for Windows. Now you have been asked to write a user’s manual for Microsoft Word for the Macintosh. The two word processors are essentially the same; the primary differences emerge from the differences between Windows and Macintosh systems. You feel that you should be able to prepare the second manual in next to no time, because you can essentially use the information you wrote for the Word for Windows manual again, with some technical changes. This is an example of re-using information and it is a common task among technical communicators. As the demand for information grows faster than the availability of people to develop that information, technical communicators are showing increasing interest in reusing information.

Carliner, Saul. Saul Carliner Studio (2003). Articles>Content Management>Single Sourcing

The Implications of Single Sourcing for Technical Communicators    

Surveys four books that examine methods of single sourcing, including publishing tools, XML, and content management systems. Reviews articles describing the roles of writers and editors, the tool set and its implementation, and ways to make dynamic content more effective

Williams, Joe D. Technical Communication Online (2003). Articles>Content Management>Single Sourcing>XML

The Implications of Single Sourcing for Writers and Writing    

Argues that single sourcing puts pressures on the workforce and the very conception of 'writer' and 'document. Examines literature on change management for clues into managing the impacts of single sourcing on writers.

Carter, Locke. Technical Communication Online (2003). Articles>Content Management>Single Sourcing>Rhetoric

Information Delivery: Single Source Documentation for Multiple Delivery Mechanisms  

Information for a software product is often presented in multiple places and in multiple formats, including printed manuals, quick-reference cards, online Help, online tutorials, online product information, and training materials. Delivery formats can include Acrobat Portable Document (.pdj files, he&n ( hlp) Jiles, HTML ( htm) files, PostScript Jiles, Write (wri) files, text files, and document book$les. Delivery media can include CD-ROM, floppy diskettes, magnetic tape, Web pages, and paper.

Flanders, Melanie G. and Nicole Y. Smart-Wycislo. STC Proceedings (1997). Articles>Content Management>Single Sourcing

Introduction to Single Source, Part 1  

In the first of a two-part article, Butland examines the arguments for and against single sourcing, a method of producing documentation for several media from a single source. He also discusses the differences between manuals and help, and offers suggestions on how to conduct single source projects involving these media.

Butland, Philip. Intercom (2001). Articles>Content Management>Single Sourcing

Introduction to Single Source, Part 2  

In the second installment of a two-part article, Butland discusses obstacles to single sourcing and how to overcome them. Part 1, which explored the advantages of single sourcing and discussed the differences between manuals and help, was published in the February 2001 issue of Intercom.

Butland, Philip. Intercom (2001). Articles>Content Management>Single Sourcing

Making the Business Case for Single Sourcing  

Discusses ways to communicate the financial benefits, customer value, learning and growth opportunities, and internal process improvements made possible by single sourcing.

Hackos, JoAnn T. and Tina Hedlund. ComTech Services (2004). Articles>Content Management>Single Sourcing>Business Communication

Making the Transition From Traditional Reference Manuals to Consumer-Oriented Alternatives  

As computers have evolved from limited-purpose, limited audience, multi-million dollar, room-sized machines to desktop machines with almost unlimited use, computer documentation has remained geared toward describing the technical attributes of software, not the use of the software. Increased competition, cost, and environmental considerations make it increasingly important to change from the paradigm of reference documentation to task-oriented documents and to consider all of the alternatives available. These include simple one-page cards, videos, online systems, and example-based user guides.

Leetham, Judith. STC Proceedings (1994). Articles>Content Management>Single Sourcing

Moving to Single Sourcing: Managing the Effects of Organizational Changes    

Argues that the move to single sourcing often requires changes within teams as new skills are introduced and members' roles shift. Points out that while some changes may threaten the stability of the team, managers can anticipate and prevent problems.

Bottitta, Jeanette, Alexia Prendergast Idoura and Lisa Pappas. Technical Communication Online (2003). Articles>Content Management>Single Sourcing>Collaboration

Oblivious Organizations and Content Management: Not Yet Ready for Prime Time  

In brief, documents are created everywhere by everyone. They each develop the documents any way they like, with no common look and feel. Company officials have vehemently opposed hiring technical communicators for the R&D teams. They feel that the engineers know the products best and should be able to write about them. Marketing materials are created independently by many different marketing staff and even by executives who regularly post announcements to the company intranet and Internet sites.

Hackos, JoAnn T. ComTech Services (2003). Articles>Content Management>Single Sourcing>Case Studies

Off the Paper and Onto the Web

In this tutorial, we’ll show you how we adapted content from a full-color, printed brochure to create a visually rich Web site for attendees at a fictional design conference. As you follow along, you’ll learn tips and tricks that can help you move content from InDesign to GoLive to get the results you want.

Adobe (2003). Articles>Content Management>Single Sourcing>Adobe InDesign

One Source, Five Deliverables: A Case Study of Return on Investment  

A case study of the implementation of a single-sourse content management system.

Martin, Ben. ComTech Services (2002). Articles>Content Management>Single Sourcing>Case Studies

Planning: The Key to Successful CMS Implementation

So you think you need content management? The temptation is to call your Information Technology (IT) department and ask them to help you choose a content management system (CMS). Being very tool oriented, your IT department will love buying you the latest 'silver bullet' without ever looking at your content requirements or your internal processes. This is the best prescription for failure.

Glick-Smith, Judith L. 'Judy'. Rockley Bulletin (2004). Articles>Content Management>Single Sourcing

Publishing for Dual Media — Paper and Electronic  

With electronic publications moving solidly into the mainstream, it is becoming apparent that steps must be taken to streamline the production process. Compared to the relative simplicity of traditional hard copy output, the electronic medium introduces new capabilities — and complexity — for publishers. Indeed, electronic publishing is not much different than programming; publishers must address issues like user interfaces, hypertext linking and context-sensitive intelligence.

New, Michael. STC Proceedings (1996). Articles>Content Management>Single Sourcing

Selecting a Content-Management System  

It's not about buying a tool; it's about understanding your requirements.

Hackos, JoAnn T. and Tina Hedlund. ComTech Services (2001). Articles>Content Management>Single Sourcing

Selecting a Content-Management System  

A discussion of the features and functions of content management software packages.

ComTech Services (2001). Articles>Content Management>Single Sourcing

Selecting the Right Single Sourcing Tool  

Tools and technologies available for single sourcing and content management have grown by leaps and bounds over the last few years, and indications are that they will continue to do so for some time to come. Understanding just what they do, and what kind of tools you need for your single sourcing or content management strategy can be confusing. The tools can be expensive, and a wrong decision can be costly. This session will cover authoring tools, content management tools, workflow, and delivery tools. This session will discuss a number of representative tools and provide guidelines for developing criteria for evaluating tools.

Rockley, Ann. STC Proceedings (2003). Articles>Content Management>Single Sourcing

Single Source in Practice: IBM's SGML Toolset and the Writer as Technologist, Problem Solver, and Editor    

Describes how single sourcing adds layers of complexity, problem solving, and project management to the writer's task. Cautions that single sourcing is often a response to a documentation requirement for the market, not to the writer's need for less complex tools.

Kramer, Robert. Technical Communication Online (2003). Articles>Content Management>Single Sourcing

Single Source Tools: An Integrated Solution  

Tools are a key component for the success of single sourcing. Tools should be selected to support the information model and development processes. This session reviews the types of single source tools (authoring, content management, publishing, and dynamic content (personalization) engines) that are available to you today. The session presentation will review the available tools.

Rockley, Ann. STC Proceedings (2001). Articles>Content Management>Single Sourcing

Single Sourcing and Chinese Culture: A Perspective on Skills Development Within Western Organizations and the People's Republic of China    

Discusses the current state of technical communication in China and analyzes key Chinese cultural values compatible with single sourcing. Reports on a skills survey conducted among Chinese and U.S. participants.

Wiles, Debbie. Technical Communication Online (2003). Articles>Content Management>Single Sourcing>China

Single Sourcing in Technical Communication

Technical Communication covers miscellaneous applications. So far you needed a separate tool for each purpose had to use several document formats for distribution and archiving. The xml-based format SVG cleans up with this misery, because SVG allows to use one single source for text, illustrations and animations ("Single Sourcing").

Fibinger, Iris. SVG Open (2002). Articles>Content Management>Single Sourcing

Single Sourcing in Technical Communication

No term has caused such a sensation in recent years among technical writers and illustrators as 'Single Sourcing.' The reasons: Enormous amounts of text and image material builds up in documentation and illustration companies. It is not uncommon for individual documents to contain several thousands of pages. If this is translated into several languages, then the administration needs are greater for both texts and graphics (graphics can contain text which must also be translated).

Fibinger, Iris. SVG Open (2002). Articles>Content Management>Single Sourcing>Technical Writing