#21709
XML provides a robust, non-proprietary, and verifiable file format for the storage and transmission of text and data both on and off the Web. XML removes the complexity of SGML, making it easier to define your own document types, and to write programs to handle them.
Bokil, Manoj. STC India (2003). Articles>Documentation>Information Design>XML
#28263
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
#27640
An XML Architecture for Technical Documentation: The Darwin Information Typing Architecture
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, allowing groups to create very specific, targeted document type definitions using a process called specialization, while at the same time reusing common output transforms and design rules. We discuss several methods that can be used to extend DITA's basic topic types.
Day, Don, Erik Hennum, John Hunt, Michael Priestley, David Schell and Nancy Harrison. WritersUA (2004). Articles>Documentation>XML>DITA
#31165
XML Documentation: The Missing Link (1)
Technical documentation is a prime beneficiary of XML technology, with standards such as DocBook and DITA. However, while XML revolutionized the way technical documentation is written, it did nothing to help documentation teams improve the collaboration process with the SMEs and other invested parties. In some cases, things got worse, with another layer of complexity added between the documentation team and the documentation stakeholders. Where is the missing link?
Talbot, Fabrice. LiveTechDocs (2008). Articles>Documentation>Software>XML
#31166
XML Documentation: The Missing Link (2)
Sharing XML documents during the writing and review process is a missing link in the XML publication chain. While Office or PDF applications help, they also add another extra-layer of complexity and lose the 'XML awareness' of our initial document. That's where LiveTechDocs comes into play.
Talbot, Fabrice. LiveTechDocs (2008). Articles>Documentation>Software>XML
#31164
XML Editors for Technical Documentation
Looking through my Programs folder, I see many programs I use to work with XML documentation. Which one is my favorite? Well, that depends on the size of my project, the size of my budget, and the file I am working on.
Mulvihill, Teresa. LiveTechDocs (2008). Articles>Documentation>Software>XML
#26313
In our Schema tutorial, you will learn what an XML Schema is, how XML Schema will replace DTD, and how to use the XML Schema language in your applications.
#26318
XML-Based Documentation Using AurigaDoc
A review of an XML-based documentation tool.
Nesbitt, Scott. NewsForge. Articles>Documentation>Software>XML
#27797
XML: the Future of Windows Help?
For a long time we've been told that XML Help is the future. So is it? In this article, David Rose examines the current state of the online help development industry and the direction it is heading.
Rose, David. Armada Online (2005). Articles>Documentation>Help>XML
#27585
A broader awareness of how changes can impact other things, including schedule commitments and work outside of the immediate area of change, is beneficial in terms of assessing trade-offs and benefits.
Ferlazzo, Ellen Lawson. XProgramming.com (2002). Articles>Documentation>Agile>Extreme Documentation
#19874
You Want It When? Approaches to Estimating Documentation Development Time 
Accurately estimating documentation effort is vital to the success of every development project, yet project managers sometimes expect the documentation team to provide accurate estimates with a minimum of information. There are many tools and methods you can use to estimate documentation efforts. Frequently, a combination of methods is most effective. Finding the best method for your documentation assignment will enhance your stature as a communication professional and delight the project manager.
Auten, Kathlyn, Joan L. Kellogg Glenda Mesomboon and Bette H. Watson. STC Proceedings (1995). Articles>Documentation>Planning>Estimating
#30260
Your Documentation Problems Solved in Five Easy Steps
It is important you know the key purpose of your document: Who is your audience? What do you want to happen as a result of someone reading it?
Cherryleaf (2007). Articles>Documentation
#19861
Your Role in Supporting Sales-Force Automation
When given a user manual to write or a Web site to put together, your role as a technical communicator is clear. But what is your role when supporting sales tools? How can you help your company market their technical products? The first step to understanding your role is to understand what a sales-force automation (SFA) solution could mean to your company. This workshop defines SFA and the potential benefits. Further discussion covers deciding on an information delivery method, determining data organization and management, and identifying audience needs.
Caldanaro, Regina M. and Jodie Pait. STC Proceedings (2000). Articles>Documentation>Writing>Technical Writing
#31144
I would argue that 'Presentation Zen' contains ideas that are also relevant to technical communication.
Pratt, Ellis. Cherryleaf (2008). Articles>Documentation>Online>Help
#24120
The Zen of Minimalism: Designing a Top-of-Class Manual for Beginners and Advanced Users
Can using minimalist documentation improve accuracy and learning speed for beginners as well as for advanced users? I tested this question using Microsoft Access for Windows 95 ® and three different third-party manuals explaining this product. Then I set up three main tasks for the user in a usability test. For each task, I provided the task description in blue type, and then copied the appropriate documentation in black. Documentation for each of the three tasks was reprinted from a different book.
Stieren, Carl. Simware (1998). Articles>Documentation>Technical Writing>Minimalism
#32083
The Steepest Part of the Learning Curve is Right at the Start
Microsoft has a lot of information on their sites about these products. Unfortunately, I can never find it. I usually only know it’s there when I stumble on it months after I really needed to know it. The steepest part of the learning curve is at the start. Likewise with another program I use occasionally—DITA. DITA is an xml schema used for writing documentation.
Technical Writer (2008). Articles>Documentation>XML>DITA
#32087
XML is the future. You hear it at every conference you go to, in every magazine you pick up, in every article you read on-line. For technical writers, right now that future comes down to two products—DocBook or DITA. But what exactly are they, and which one should you choose? They are schemas for creating XML.
Technical Writer (2006). Articles>Documentation>DocBook>DITA
#32089
As part of the product, testing documentation seems like an obvious thing to do, but what does it really mean? I’ve fielded the question in a few different places now and it’s always interesting to delve deeper and understand the rationale behind the request.
McLean, Gordon. One Man Writes (2008). Articles>Documentation>Assessment>Testing
#32092
A Curmudgeon's Guide to Computer Documentation
Is documentation a bad word? It is if you’re the Curmudgeon, a character I invented, who some say bears an amazing resemblance to … me.
West, Mike. MBWest.com. Articles>Documentation>Technology>Technical Writing
#32093
A very brief review of the first edition of Edmond H. Weiss’s How to Write a Usable User Manual.
West, Mike. MBWest.com (2006). Articles>Reviews>Documentation>Technical Writing
#32096
Structured Writing, Structured Documentation: What and Why?
A brief comparison of two often-confused concepts.
West, Mike. MBWest.com (2007). Articles>Documentation>Information Design
#32144
In my work with Bumblebee I use an approach I call 'User-Guide-Driven Development,' or UGDD for short. The mechanics of UGDD is similar to that of Test-Driven Development (TDD), but before I write the test for a feature, I write a snippet of the user guide describing the feature I am about to implement.
Brolund, Daniel. Thoughts of a Goldfish (2008). Articles>Documentation>Usability>User Centered Design
#32145
By partly adopting the process suggested by Daniel Brolund we, the technical writing team, can be involved right up front and the documentation can be one of the methods used to validate the software as it is being built.
McLean, Gordon. One Man Writes (2008). Articles>Documentation>Writing>Technical Writing
#32146
Getting FLOSSy: Acrobat Killer Or HAT Replacement?
Some writers truly hate Adobe Acrobat and any tool that can do the job better is worth a shot, particularly if it’s open source and easily navigated. Flossmanuals.net introduces FLOSS which does a lot of the single desktop Acrobat Pro’s job - collaboratively and open source.
Jeter, Charles. Charles Jeter (2008). Articles>Content Management>Documentation>Software
#32156
Documentation and Agile Software Development
What’s it like doing documentation as part of an Agile software development team? Why is it a better way of working? I mull this over these and other questions with Graham Campbell.
Christie, Alistair and Graham Campbell. ITauthor (2008). Articles>Documentation>Agile>Podcasts
