The Convergence of Technical Communication and Information Architecture: Managing Single-Source Objects for Contemporary Media    

Single sourcing, XML, and other forms of multimedia have changed technical communicators' work processes and on-the-job duties. Beyond the requirements for traditional skills in writing, editing, and designing, technical communicators must now play enhanced roles within professional environments including organizing, creating, and managing information. To help simplify the complex tasks of creating multimedia documents, in this article we examine the impact that new technologies have had on the technical communication profession. Referring to a wide variety of sources about the fundamental changes to our profession, we synthesize information regarding managing multimedia documents. Although in this article we focus on object management, with an emphasis on the tasks, skills, and tools required of authors of such documents, in future articles we will address object creation and object presentation.

Mott, Richard K. and Julie Dyke Ford. Technical Communication Online (2007). Articles>Information Design>Single Sourcing

Convert XML to JSON in PHP

With the growing popularity of Web 2.0, a new data interchange format called JavaScript Object Notation (JSON) is emerging as a useful way to represent data in the business logic running on browsers. Learn how PHP-based server programs can convert XML-formatted enterprise application data into JSON format before sending it to browser applications.

Nathan, Senthil, Edward J Pring and John Morar. IBM (2007). Design>Web Design>Information Design>Ajax

Converting Legacy Documents to Hypertext

When I first came to Boeing, my workgroup delivered documents (stored either in Microsoft Word or XyWrite) in hardcopy format. As more modern document delivery options were made available to us, I convinced the customers, development staff and the management to adopt these new technologies to make documentation maintenance and delivery easier. I also converted over 1000 pages of documentation (such as language reference manuals, quick reference guides, installation guides and user guides) from strict text formatting to hypertext. This chapter will share what I learned with you. Here are some guidelines I recommend you follow when you begin to convert your paper-based documents to hypertext. Each guideline will be expounded later in this chapter.

EServer (2001). Design>Information Design>Hypertext

Converting Word Documents with Embedded Files  

How can I convert Word documents to PDF and ensure their embedded Excel documents also get converted?

Boulay, J.R. PDFzone (2004). Design>Information Design>Software>Adobe Acrobat

Corporate Design Manuals, CSS, Information Architecture and Object Oriented Programming Follow the Same Principle. They are Modular

Corporate design manuals are modular. Information technology is modular. They're both modular because modularity is the only way to deal with complex information such as corporate design for multinationals or thousands of lines of code.

Information Architects Japan (2006). Design>Information Design

COTS: The New Challenge of Information Integration  

Systems engineering is moving away from specially-designed and built systems to integration of commercial off-the-shelf (COTS) hardware and software. COTS brings new challenges to technical communicators. In the past, we found all our information in-house, now it comes from many sources. We must change our process from pure development to information integration, and we must be part of the COTS selection process.

Lenk, Donald S. Jr. STC Proceedings (1998). Presentations>Information Design>Software

CPTec Forum

Discussion of a variety of TC software platforms.

CPTec GmbH. (German) Resources>Collaboration>Information Design

Create an XML Schema Document from an Instance or DTD

There are several tools that can help you generate an XML Schema document from either an instance or a DTD. This hack shows you how to get the job done with little fuss.

O'Reilly and Associates (2005). Articles>Information Design>XML

Create Well-Formed XML with JavaScript

Use JavaScript to ensure that you write correct, well-formed XML in web pages.

O'Reilly and Associates (2005). Articles>Information Design>XML

Creating a Template for a Large Web Site: the U.S. EPAWeb Branding Experience  

Staff at the U.S. Environmental Protection Agency created a template then steadily converted Web pages to achieve a 'corporate face' for www.EPA.gov, the Agency's Internet site. Management and maintenance of Agency Web pages rests among the technical subject matter and administrative experts within headquarters, program, and regional offices and laboratories – rather than centralized. Template design, deployment and conversion involved many employees and contractors nationwide, and took almost one year. As of February 1, more than 90% of EPA's Internet pages comply with the template, and staff continue improvements to the Agency's public Web resources.

Ellis, Leonid 'Lee'. STC Proceedings (2003). Design>Web Design>Information Design

Creating Documents with Structural Markup  

Now we come to the point of actually producing documents using structural markup—either eXtensible Markup Language (XML) or Standard Generalized Markup Language (SGML). Our sequence of topics illustrates the recommended steps to follow when you first implement structural markup: Learn about it and convince yourself and your organization of its benefits, identify your specific goals and expectations, and spend plenty of time selecting or designing your document structures. Only then should you get down to the specifics of how to produce XML or SGML documents. If you simply try to drop in an XML editor to replace your current word processing application, you will be lucky to avoid total disaster.

Tyson, Paul H. Intercom (2004). Articles>Information Design>SGML>XML

Creating Dynamic Stamps

Dynamic stamps consist of the PDF image of the stamp and a text form field that contains JavaScript to make your stamp dynamic. For example, the Dynamic Stamp 'Approved' contains a form field that generates user name, time and date.

DeFurio, Lori. PlanetPDF (2003). Design>Information Design>Software>Adobe Acrobat

Creating the Relationship-Centric Organization: Nonprofit CRM

Are you storing data about your constituents in three, five, even ten different databases? If so, you're not alone ' but it's costing you in time, lost revenue and decreased impact. Paul Hagen describes how to get all your data into one place with an integrated CRM strategy.

Hagen, Paul. IdealWare (2006). Articles>Information Design>Databases>CRM

Creating XML Content  

Houser provides an overview of XML editors. He discusses in detail three of the most popular content-oriented editors: ArborText Epic, Adobe FrameMaker 7, and SoftQuad XMetaL.

Houser, Alan R. Intercom (2002). Design>Information Design>XML>Adobe FrameMaker

Creating XML Trees with the XmlTextWriter and XmlDocument Objects

So you know all about reading and parsing XML files, and even checking if they're well-formed and valid. Now, take a step into more advanced territory with this expose of two objects that let you dynamically create well-formed XML documents in your ASP.NET scripts.

ASP Free (2004). Articles>Information Design>Software>XML

The Curse of Information Design

Information Architecture may be good for the web business, but Cohen thinks it is killing the web's subtler creative values.

Cohen, Scott Jason. List Apart, A (2001). Design>Web Design>Information Design

Customer Profile: Ernest Svenson, PDF for Lawyers

A well-known advocate for the effective use of new technologies in the legal profession, New Orleans-based attorney Ernest Svenson finds Adobe Acrobat and PDF to be highly valued tools in a document-intensive field.

Foss, Kurt. Adobe (2007). Articles>Information Design>Legal>Adobe Acrobat

The Dangers of Personalization

Personalization is coming to technical communication, and the results may not be pretty. n offering the individual an opportunity to pick and choose among XML content objects, we risk causing confusion when the organization of the site appears to shift, and familiar landmarks disappear. Critical content may become invisible to the user. The very process of creating preferences, custom options, or an entire personal profile adds a complex distraction that many users may resent, because it takes them away from their original task for so long that they forget what they were doing. Even advanced search mechanisms, which promise to pinpoint the exact information object the user wants, risk baffling users with their own complexity.

Price, Jonathan R. Communication Circle, The (2001). Presentations>Information Design>Adaptive

Darwin Information Typing Architecture

Darwin Information Typing Architecture (DITA) is an XML-based architecture for authoring, producing, and delivering technical information. The architecture and a related DTD and a W3C-Schema was developed by IBM.

Wikipedia. Articles>Information Design>XML>DITA

Darwin Information Typing Architecture (DITA XML)

DITA is an architecture for creating topic-oriented, information-typed content that can be reused and single-sourced in a variety of ways. It is also an architecture for creating new information types and describing new information domains based on existing types and domains. This allows groups to create very specific, targeted document type definitions using a process called specialization, while still sharing common output transforms and design rules developed for more general types and domains.

Cover Pages (2005). Articles>Information Design>XML>DITA

Data Collection for Controlled Vocabulary Interoperability: Dublin Core Audience Element

This paper outlines the assumptions, process and results of a pilot study of issues of interoperability among a set of seven existing controlled vocabulary schemes that make statements about the audience of an educational resource.

Tennis, Joseph T. ASIST (2002). Articles>Information Design>Metadata>Controlled Vocabulary

Data Warehousing

A decision support database that is maintained separately from the organization's operational database. Support information processing by providing a solid platform of consolidated, historical data for analysis.

GNULAMP (2005). Resources>Information Design>Databases

Database Modelling in UML - Part 1

When it comes to providing reliable, flexible and efficient object persistence for software systems, today's designers and architects are faced with many choices. From the technological perspective, the choice is usually between pure Object-Oriented, Object-Relational hybrids, pure Relational and custom solutions based on open or proprietary file formats (eg. XML, OLE structured storage). From the vendor aspect Oracle, IBM, Microsoft, POET and others offer similar but often-incompatible solutions. This article is about only one of those choices, that is the layering of an object-oriented class model on top of a purely relational database. This is not to imply this is the only, best or simplest solution, but pragmatically it is one of the most common, and one that has the potential for the most misuse.

Sparks, Geoffrey. Methods and Tools. Articles>Information Design>Databases>UML

Database Templates with MySQL

Once you've built several MySQL databases, you'll learn some shortcuts to database design. Why stop there? Take this trick a step further and put together a generic database with a set of empty, standard tables. With a well-designed MySQL template, you can quickly assemble the basics of any database as needed. A template also allows you to focus on the more interesting aspects of a database project.

Dyer, Russell. O'Reilly and Associates (2004). Articles>Information Design>Databases>SQL