Eliminating the END GAME from Electronic Deliverables

While executive management may sometimes believe that anyone can write and that a technical writer's job is to "Just Publish It", it may be time for technical writers to look at what they can do to improve the "end game" process, which Porter describes as "All the steps needed to create the desired output format – HTML, PDF, online help system, etc. – from the source content." By taking a closer look at the publishing process, without regard to content, technical communicators may discover ways they can streamline the steps it takes to get content published and ready for the end consumer.

Porter, Alan J. Writing Assistance (2005). Articles>Content Management>Single Sourcing>Online

An End-to-End Multilingual Content Management System  

This article will not try to answer why there's no end-to-end content management solution that supports the whole process from single-source authoring to multilingual publishing. At least, it cannot be bought off-the-shelf. Only companies with the size of J.D.Edwards are able to integrate the various components. They will even find the resources and the necessary expertise to implement vital components that are not readily available on the market (e.g. multilingual terminology management system).

Vangilbergen, Ludo. STC Proceedings (2002). Design>Content Management>Single Sourcing>Language

Enterprise Content Management: A Critical Review  

A presentation about the use of ECM within the CMSwatch website.

Byrne, Tony. IAsummit (2004). Articles>Content Management>Single Sourcing

Enterprise Profiling  

Documents play a vital role in Enterprise Content Management. Unlike other content sources, 'document' creation and capture can occur at every desktop, in every process, and by every on-line application.

Strong, Karen V. KMworld (2001). Articles>Content Management>Single Sourcing

Evolving Client Content

Content management systems are only as good as the content they manage. Garrity explores the care and feeding of low-budget clients who need high-quality content.

Garrity, Steven. List Apart, A (2001). Design>Content Management>Single Sourcing>Web Design

Fight the Unbeatable Foe: Challenges in Implementing Single Sourcing  

Single sourcing documentation is a hot topic among technical writers these days, but very few organizations have implemented single sourcing strategies or solutions. This session presents the problems faced by organizations that want to move towards single sourcing and steps to successfully implement a single sourcing strategy and solution in your organization.

Sukach, Rebecca, Robert Kennedy and Marie Devine. STC Proceedings (2003). Articles>Content Management>Single Sourcing

From Web to Print

The Web is WYSIWYG. What you see is what you get. What you see on the monitors and via the connections - and what you use for beta testing - is what your work will look like to all those who check out your URL. What's on your screen will be pretty close to what's on their screens. Print is a different matter altogether. Once your files leave your computer, there's a whole wonderful road they have to journey along to make it into print. You do everything you can to make sure they're ready for their adventure, but just as you're likely to forget your toothbrush or your favorite socks when you take a trip, your files often go to print missing a vital item. You can only hope that the thing you forgot about is easy to correct and not a big expensive mistake that blows your deadline and your budget. Getting your files through your service bureau (where your files are turned into negatives so that your negatives ultimately become the finished product) and to the printer is like taking up the gauntlet. Best case scenario, you'll be winded; worst case, you'll be pounded to a bloody pulp. I fear I'm showing my bias toward the Web.

Frew, Jim. Webmonkey (1999). Design>Content Management>Single Sourcing

Fundamental Concepts of Reuse  

Content reuse is fundamental to a successful unified content strategy.This chapter defines content reuse and the benefits ofits use.It explores how other industries have employed reuse for decades to improve their processes and the quality oftheir products. Content can be reused in many ways. The choice ofthe different methods and options for reuse are dependent upon your organization’s needs and technology.This chapter details the pros and cons ofusing each method and the associated options,and it provides the concepts that underlie the remainder ofthe book.

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

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 Impact of Single Sourcing and Technology    

Design of information tends to be controlled by the functionality of the tools and technology. The last decade has seen a powerful move to online materials and a move away from paper. The next 5 years will see a move to new ways of structuring information for multiple media, multiple audiences, and multiple types information. The use of document databases, single sourcing, and knowledge webs will redefine 'writing.' As we move into the next millennium, information developers need to take control of the technology to support information design. This article addresses the changing face of technology, information design, and skills required to ensure effective information development in support of user needs.

Rockley, Ann. Technical Communication Online (2001). Design>Information Design>Single Sourcing

Implementing Single Sourcing in Your Organization  

Single sourcing is more complex than buying a new software application. To ensure a successful migration, you must carefully understand the documentation development processes in your organization, what single sourcing is, and what software is available to facilitate it. Because you must change the way your organization creates and maintains documentation, you must sell your organization on the changes and their cost. Finally, you must develop training to help transition writers to your single sourcing methodology.

Sukach, Rebecca, Robert Kennedy and Marie Devine. STC Proceedings (2002). Design>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

The Indoition Page

Articles, links, downloads and working aids for user assistance professionals and technical writers. Main focus is on software documentation (online-help) and single source publishing.

Achtelig, Marc. indoition engineering (2005). Resources>Information Design>Single Sourcing>Writing

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

Information Modeling for Single Sourcing  

Single sourcing involves identifying all information requirements up front, then developing them from a single source. Information is broken down into elements, which are reused wherever they are required. Information models identify to writers all the required elements, how to structure them, and how to reuse them. This paper describes the process of information modeling.

Kostur, Pamela and Ann Rockley. STC Proceedings (2001). Presentations>Information Design>Single Sourcing

Integrating Local and CRI Online Documentation Using SGML and DynaWeb  

This paper tells how Lawrence Livermore National Laboratory enriched CRI's online documentation set by publishing local manuals using the same SGML DTD used by CRI and delivered using (a more sophisticated version of) the same World Wide Web server (DynaWeb 3.0). This approach supports flexible local content and styles, yet integrates local and CRI manuals through one access mechanism and user interface. We explain the basic strategy involved, compare the benefits of this approach with three alternatives, and discuss the problems to which it gives rise.

Girill, T.R. Delft University (1996). Articles>Documentation>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

An Introduction to Single-Sourcing  

A brief, high-level introduction to single-sourcing.

Simply Written. Design>Content Management>Single Sourcing

The Joy of Single-Sourcing

At MYOB® (Mind Your Own Business) Australia, we have just finished our first single-sourcing project using mif2go to convert FrameMaker source files to HTML Help *.chm files. These files are also the source of our printed user guide and the hyperlinked PDF of the user guide placed on the distribution CD. There was considerable once-off pain setting up conversion templates (including CSS files) and conversion options but our next project will be much faster. The converted files do not require any hand tweaking -- we just hand over to the release people to put the *.chm file on the installer CD. Our testing and support people are rapt, and consider the new help far better than the old help. It has a navigation pane with Contents, Index, Search, and Favorites tabs, a toolbar with Hide [navigation pane], Prev, Next, Back, Forward, Print, Options, and Welcome (custom Home) buttons. An outsider would have no inkling that the help was converted from FrameMaker source files as the appearance is completely different from the printed book and hyperlinked PDF. You, too, can single-source successfully provided you plan beforehand and your team understands the process.

Finger, Hedley. IRTC (2001). Design>Content Management>Single Sourcing

Making a Business Case for Single Sourcing  

As we learned in the February 2001 issue of Best Practices, in JoAnn Hackos' review of the book, The Balanced Scorecard, selling innovative ideas to upper management is important. The Balanced Scorecard approach includes a customer perspective, an internal-business-process perspective, and a learning and growth perspective, in addition to the financial perspective. A solid and balanced business case allows you to gain management support and reach your goal.

Center for I.D. Management, The (2001). Design>Content Management>Single Sourcing>Business Case