Creating Online Help from FrameMaker Files Using WebWorks Publisher 
WebWorks Publisher from Quadralay lets you develop online help from FrameMaker files without dealing with the inefficiencies associated with help authoring tools (HATs). No longer do you have to convert the FrameMaker files to RTF for use in a HAT—and consequently lose all the formatting, which you must rebuild. You also do not have to maintain two sets of files.
O'Keefe, Sarah S. STC Proceedings (1999). Articles>Documentation>Online>Adobe FrameMaker
Friend or Foe? Web 2.0 in Technical Communication 
The rise of Web 2.0 technology provides a platform for user-generated content. Publishing is no longer restricted to a few technical writers—any user can now contribute information. But the information coming from users tends to be highly specific, whereas technical documentation is comprehensive but less specific. The two types of information can coexist and improve the overall user experience. User-generated content also offers an opportunity for technical writers to participate as “curators”—by evaluating and organizing the information provided by end users.
O'Keefe, Sarah S. Scriptorium (2008). Articles>Web Design>Technical Writing>Social Networking
Paradigm Shifts are Never Pretty: Advice on Making the Move to XML Authoring
Most people are risk-averse, and profound changes such as the move to structured authoring require new skills and workflows. To ensure a successful transition, XML implementers need to assess their team members, identify allies, and build their implementation strategy around the staff members who embrace change.
O'Keefe, Sarah S. Content Wrangler, The (2008). Articles>Content Management>Project Management>XML
Publishing XML Content with XSL

How do you convert your application-neutral, vendor-neutral, unformatted XML content into paginated content (such as PDF) or HTML? O'Keefe introduces one solution: the Extensible Stylesheet Language, a programming language for processing XML.
O'Keefe, Sarah S. Intercom (2008). Articles>Information Design>XML>XSL
Sorry, guys, but what you're describing is "single sourcing" and it's been around for a while. And I don't think redefining "dynamic publishing" is going to work, either, because that term already means something.
O'Keefe, Sarah S. Palimpsest (2008). Articles>Document Design>Single Sourcing>QuarkXPress
Social Media 101: Now Everyone's a Technical Writer
Free and cheap tools (blogging software, cheap digital cameras) have made "many-to-many" communication possible. This is sometimes called the "rise of the creative class." People are shifting from being consumers to creators.
O'Keefe, Sarah S. Palimpsest (2008). Articles>Writing>Collaboration>Social Networking
Implementing structured authoring with XML allows organizations to create better content. The addition of hierarchy and metadata to content improves reuse and content management. These benefits, however, must be weighed against the time and money required to implement a structured authoring approach. The business case is compelling for larger writing organizations; they will be the first to adopt structured authoring. Over time, improvements in available tools will reduce the cost of implementing structured authoring and make it affordable for smaller organizations.
O'Keefe, Sarah S. Scriptorium (2002). Design>Publishing>Information Design>XML
Structured Authoring and XML: Part One
Implementing structured authoring with XML allows organizations to create better content. The addition of hierarchy and metadata to content improves reuse and content management. These benefits, however, must be weighed against the time and money required to implement a structured authoring approach. The business case is compelling for larger writing organizations; they will be the first to adopt structured authoring. Over time, improvements in available tools will reduce the cost of implementing structured authoring and make it affordable for smaller organizations.
O'Keefe, Sarah S. Carolina Communique (2003). Articles>Documentation>Information Design>XML
Structured Authoring and XML: Part Three
Not every content-creation group will benefit from structured authoring and XML. Sometimes, the expense of implementation outweighs the benefits realized, especially in smaller groups with less total page count.
O'Keefe, Sarah S. Carolina Communique (2004). Articles>Documentation>Information Design>XML
Structured Authoring and XML: Part Two
In a structured authoring environment, authors create documents by assembling elements and text in an order permitted by the structure definition document. You might think of structured authoring as being similar to template-based authoring with a strict template. Authors do not assign formatting; the formatting is automatically assigned based on the structure of the document. Formatting may differ for different output media.
O'Keefe, Sarah S. Carolina Communique (2003). Articles>Documentation>Information Design>XML
XML-based publishing challenges authors to convert from the familiar desktop-publishing routine to new tools. This article explains what you should consider when deciding whether to implement XML.
O'Keefe, Sarah S. Intercom (2007). Articles>Information Design>XML
XML Architecture for Customized User Assistance
Content reuse enables technical communicators to create multiple deliverables from a single set of source documents. A key component of reuse is identifying which information belongs in which deliverable. Some customization is feasible with build tags (RoboHelp), conditional text (FrameMaker), topic reuse (FrameMaker and AuthorIT), and similar features.
O'Keefe, Sarah S. WritersUA (2005). Articles>Documentation>XML>Adobe FrameMaker
XML Architecture for Customized User Assistance
To create a specific deliverable, you collect all of the relevant topics and wrap information around them. A printed book, for instance, contains topics grouped into chapters along with front and back matter.
O'Keefe, Sarah S. WritersUA (2005). Articles>Information Design>Help>XML
In this podcast, Sarah O’Keefe talks about XSL, Flash, and live blogging. XSL (extensible stylesheet language) is a programming language that transforms XML content into a specific format, such as HTML. She explains what you can do with XSL, why it’s unique, and how the output is created.
O'Keefe, Sarah S. and Tom H. Johnson. Tech Writer Voices (2008). Articles>Interviews>XSL>Podcasts
Paradigm Shifts are Never Pretty: Advice on Making the Move to XML Authoring
The move toward XML-based authoring in technical publications is a classic paradigm shift. It requires content creators to change their writing process and learn new concepts.
O'Keefe, Sarah S. TechCom Manager (2008). Articles>Writing>XML>Technical Writing
In the past few years, we have implemented both DITA-based and custom XML solutions for our customers. Given the right set of circumstances, DITA provides an excellent foundation for structured content. But I seem to be in significant disagreement with DITA advocates about how often the "right set of circumstances" is present.
O'Keefe, Sarah S. Carolina Communique (2008). Articles>Documentation>XML>DITA
Many people see DITA architecture as a shortcut to avoiding content modeling. O'Keefe warns readers against this mistake.
O'Keefe, Sarah S. Intercom (2008). Articles>Information Design>XML>DITA
What Do Movable Type and XML Have in Common?

Compares Gutenberg's invention of the movable type to the creation of XML. But where movable type changed the “economics of a mechanical process,” XML changed the “economics of content authoring, formatting, and customization.”
O'Keefe, Sarah S. Intercom (2008). Articles>Information Design>Publishing>XML
Web 2.0: The Tipping Point for XML

Have you been waiting for the right time to switch to XML publishing? O’Keefe illustrates that with the advent of Web 2.0, the time is now.
O'Keefe, Sarah S. Intercom (2009). Articles>Web Design>XML>Social Networking
A blog about publishing and technical communications.
O'Keefe, Sarah S. Scriptorium. Resources>TC>Documentation>Blogs
Building Efficient Multilingual Workflows

O’Keefe gives detailed information on two technology standards that may be used in multilingual workflows: XSL and XLIFF.
O'Keefe, Sarah S. Intercom (2009). Articles>Content Management>Workflow>Translation
As you may have heard, STC is in a financial crisis. According to the board of directors meeting minutes from May 5, 2009, STC must retain membership "for the next year or STC will be out of business in two years." I believe that STC needs to make some significant changes in the following areas.
O'Keefe, Sarah S. Palimpsest (2009). Articles>TC>Community Building>STC
This is the Future of Technical Communication
In the absence of safety concerns, I think that accuracy must win. Thus, as the information curator, you have a responsibility to correct inaccurate information. If the inaccuracy is truly dangerous, you may need to edit the post directly. Make sure that you disclosure what you've done with brackets.
O'Keefe, Sarah S. Palimpsest (2009). Articles>TC>Technical Writing>Wikis
The authoring tool does matter. Writers are focusing on the wrong set of issues (leading, kerning, print formatting), none of which is actually relevant for the output.
O'Keefe, Sarah S. Palimpsest (2009). Articles>Documentation>Technical Writing>Software
A Strident Defense of Mediocre Formatting
Formatting automation removes cost from the process of creating and delivering content. For technical documents that change often and are perhaps delivered in multiple languages, it removes a lot of cost. Essentially, we can produce documents inexpensively and give more people access to them as a direct result of lower cost, or we can climb on our typographic high horse and whine about word spacing. I’m with the noisome fanboys.
O'Keefe, Sarah S. Scriptorium (2009). (Afrikaans) Articles>Document Design>Typography>Minimalism
There are 19 readers currently online: 2 registered users and 17 guests. Register.

![]()
![]()


![]()
![]()
![]()