Developing the Specification for a Document

Between 25-30 percent of the overall writing time is typically devoted to developing the document specification, meaning how the document will be formatted and actually present the information. This is true even when the organization has a style guide with a prescribed format, but no “standard” for documentation overall. Although this may seem an inordinate amount of time and effort on the front end, before getting any information onto the paper, it is far more cost-effective than spending unplanned time rewriting and reformatting the document late in the production process.

Tech-Writer. Articles>Writing>Project Management>Technical Writing

Empathize with the Writer    

It is my firm belief that every technical writer is passionate about her work and would put in her best efforts to deliver high quality. If you are a manager or an editor and are shaking your head in disagreement, think again. Why would someone want to submit a work of poor quality?

Lawrence, Prema. International Journal for Technical Communication (2006). Articles>Writing>Project Management>Technical Writing

From Technical Writing to Knowledge Engineering  

This paper describes one writer's journey from capturing disparate bits of information as a technical writer in a large corporation to creating knowledge bases of related and evolving data, information, and knowledge. It illustrates how information development professionals can leverage their communication skills into highly-valued, interactive positions, working on teams with domain experts, information technology and information retrieval professionals, and end-users.

Knodel, Elinor L. STC Proceedings (1998). Articles>Writing>Knowledge Management>Technical Writing

The Hidden Relationship Between Project Managers and Technical Writers  

Want to know the secret to better quality documentation and improved software design? Will Kelly outlines how the key is an effective relationship between project managers and technical writers.

Kelly, William T. TechRepublic (2003). Articles>Collaboration>Project Management>Technical Writing

The Implications for Technical Writers of the Movement Toward Open Systems  

The movement toward open systems is gaining momentum. Those technical writers in the computer and software industries who have been accustomed to working in the world of proprietary systems will have to adjust to working in this new world of open systems. This paper briefly describes the open systems movement and then discusses in detail the implications of that movement for technical writers. This includes the challenges they will face and the skills they will need to develop. A brief case study of the involvement of technical writers in the Open Software Foundation’s DCE project is included.

Abbott, John J. STC Proceedings (1993). Articles>Knowledge Management>Open Source>Technical Writing

Leveraging Complex Content for the Support Chain  

The support chain is becoming increasingly important as we begin to understand the deep underlying economic trends of the last half-century.

Osnat, Rani. ComTech Services (2001). Articles>Content Management>Technical Writing

Meaningful Microcontent

Microcontent refers to small, granular, and possibly representative (that can provide a summary of or a navigation to a larger set of information) bits of information, typically available on the Web. An example in the domain of journalism might be headlines and news summaries, small bits of content that can be used on a front page of the news with links to more in-depth articles. The definition has grown in scope as much as in its application.

Albing, Bill. KeyContent.org (2006). Articles>Documentation>Content Management>Technical Writing

Quality Documentation: ISO 9000 as a Process Model  

While ‘quality’ is no longer the most popular buzz-word, there is still a need for thorough understanding of what it means to document a quality program. In preparing for ISO 9000 certification, I developed useful techniques which can be used to improve quality in other documentation tasks. Even if you're not involved in ISO 9000, it can serve as a good general model for documentation management. This paper briefly describes the ISO 9000 standard and the process of certification, how documentation in a quality program is different than usual technical documentation. and some of the useful tools and techniques.

Magyar, Miki D. STC Proceedings (1996). Articles>Management>Policies and Procedures>Technical Writing

Real Costs Of Technical Publications  

This workshop shows a technical publication manager or rising professional how to work in the following technical publishing/financial areas: project management, operating budget preparation and management, and quality control.

Caernarven-Smith, Patricia. STC Proceedings (1994). Articles>Publishing>Technical Writing>Project Management

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

Six Reasons You Don't Need a Technical Writer (and Why They're Dead Wrong!)

Hiring the right freelancer to do the job correctly the first time around could save you hundreds or thousands in help desk calls, service calls, document revision, and distribution. Here's why.

Zuccardy, Ann. Ezine Articles (2005). Articles>Project Management>Writing>Technical Writing

A Tale of Two Technical Writing Teams  

Sometimes considered an afterthought in the product development lifecycle, technical writers often struggle to become part of a performing Agile team.

Broderick, Stacia. Rally Software Development (2007). Articles>Project Management>Agile>Technical Writing

Using the Triage Method in Technical Writing

Pragmatism is the necessary first step: do the best job you can do under the conditions. Nobody's going to benefit if you do a superb job on half the manual, then die of stress before you can document the important parts in the second half.

Hart, Geoffrey J.S. Geoff-Hart.com (1999). Articles>Project Management>Writing>Technical Writing

A Virtual Conversation on Bernadette Longo's Spurious Coin: A History of Science, Management, and Technical Writing    

A collection of responses to Bernadette Longo's Spurious Coin.

Gaskill, David, Mary Been, Margaret N. Hundleby and Pete Praetorius. Journal of Computer Documentation (2001). Articles>Management>Scientific Communication>Technical Writing

Web Application Maps Business Opportunities

A technical writer develops a way to help a government contractor uncover procurement opportunities -- and in the process discovers a new opportunity for himself as an information profit center.

Montague Institute Review (1998). Articles>Knowledge Management>Information Design>Technical Writing

The Why and How of Content Convergence and Integration

Content producers are about to live through interesting times, to adapt the popular saying, with the dawning of The Age of Content. Industry is discovering content as a commodity; the rules are changing, and fast. What have traditionally been seen as the lowliest form of commercial content within an enterprise, technical manuals, are starting to take their place alongside the other valued corporate assets.

Bailie, Rahel Anne. Writing Assistance (2007). Articles>Content Management>Documentation>Technical Writing

Why Writing Deadlines May Be (Almost) As Good As Money

As much as we all like and/or need money, getting paid may not be enough to keep a writer motivated. Deadlines often are just as important. Although some of us fear — or even hate — them, the truth is that without them many of us simply wouldn’t write anything. And you can count me among those many.

Hewitt, John. Writer's Resource Center (2008). Articles>Writing>Technical Writing>Project Management

XML Authoring: Coming to a Desktop Near You

XML for use in technical publications is growing in popularity. As the author explains, technical writers are likely to become more and more involved in XML document production in the future. This article looks at the many benefits of XML authoring and the trend that's moving technical publications toward structured content.

Abel, Scott. Writing Assistance (2007). Articles>Content Management>XML>Technical Writing

Potential Position Descriptions for Information Engineering Professionals

This article defines the tasks and responsibilities for up to seven levels of information engineers, plus two levels of management.

Capri, Steve. TechCom Manager (2007). Articles>Management>Information Design>Technical Writing

How to Justify Hiring Technical Writers During Hard Economic Times

With our economy still on the down slope, it is difficult for technical managers to justify keeping an excessive amount of technical writers on their staffs, let alone hiring new ones. In many cases, managers feel they don’t even need writers, arguing that everyone has writing ability. Of course, today’s technical writers not only write, they also perform many other tasks: programming, web development, training, and so on. Add to that the fact that many are also highly trained and certified in other areas besides writing.

Datta, Aparna. TechCom Manager (2005). Articles>Management>Writing>Technical Writing

Content is King

Are you getting hung up with the XML and all of the other Content Management goodies and forgetting about the CONTENT?

Great Technical Writing (2008). Articles>Writing>Technical Writing>Content Management

When Trust Becomes a Characteristic Flaw in a Project

As hard as it may seem, lesson one of technical writing is to break the rules and contact the end user. Conduct a mini-ethnography. Sit with the users. Call them on the phone. Send them emails. Do not let it get to the point where you feel you must go through the PM to communicate with the end user. As hard and uncomfortable as it may be, the consequences of not talking to the end user can be crippling to your help.

Johnson, Tom H. I'd Rather Be Writing (2008). Articles>Project Management>Collaboration>Technical Writing

Technology Transfer: An Unparalleled Opportunity for Technical Writing Professionals    

This nation does not effectively transfer expensively acquired knowledge into cost-effective, labor-saving tools and processes.

Roberts, Suzanne S. IEEE PCS (1991). Articles>Knowledge Management>Technical Writing>Technology Transfer

Advantages of Using Microsoft SourceSafe While Writing Your Technical Documents

Microsoft’s Visual SourceSafe was not created with technical communicators in mind. It was created for engineers writing software source code. But it is successfully used by technical writers in offices around the world to control documentation.

Technical Communication Center (2009). Articles>Content Management>Documentation>Technical Writing

The Many Faces of Content Management: A Primer

None of the technologies mentioned so far support the production of content for purposes of producing technical documentation. Such a system is a specific type of content management that has specialized functions for technical communicators doing multi-channel publishing, yet it hasn't spun off its own specific acronym.

Bailie, Rahel Anne. STC San Diego (2006). Articles>Content Management>Documentation>Technical Writing