A directory of resources inthe field of technical communication.

Presentations>Documentation>Information Design

6 found.

About this Site | Advanced Search | Localization | Site Maps



How Much Documentation is Enough?   (PDF)

Examines the need for defining the scope of documentation projects up front, and provides strategies for implementing a zero-based scoping approach.

Dhanagopal, Kumar. STC India (2010). Presentations>Information Design>Content Strategy>Documentation


An Information Make-Over for Performance Centered Design   (PDF)

Technical communicators have long harbored a secret that we are reluctant to admit to outsiders: Users don’t like reading manuals. They do it only as a last resort. Even online help systems, which we originally hoped would be easier to use, have not met with great enthusiasm among users. It’s an all-too-common dilemma – there is a lot of information that could be explained, but users struggle along as best they can without it. Part of the problem has always been that users are reluctant to leave their work to seek information -- and rightly so. They have work to do and deadlines to meet. Even if your manual or online help contains a wealth of useful information, it takes them away from their work and interrupts their train of thought. If they do try to use it, the help window typically overlays the interface and adds its own set of navigation, resizing, and searching issues.

Battle, Lisa H. STC Proceedings (2000). Presentations>Documentation>Information Design


Structured Authoring and DITA

What does structured authoring mean to you? Structured authoring is a publishing workflow that lets you define and enforce consistent organization of information in documents, whether printed or online. What it means to me: defining a goal and assembling architected topics to help the reader achieve that goal.

Vazquez, Julio J. SDI Global Solutions (2009). Presentations>Documentation>Information Design>DITA


Structuring Help for Re-Use   (PDF)

Many teams are still laboring to transform poorly organized manuals into online help. But the biggest cllallege you face going from paper to online is not interface, but structure The better your structure, the easier your users will navigate.

Price, Jonathan R. STC Proceedings (1995). Presentations>Documentation>Information Design


"Yes, But Does it Scale?": Practical Considerations for Database-Driven Information Systems   (peer-reviewed)   (members only)

This paper explores the process of designing and implementing a database-driven system of online documentation, and putting it live on the web for customers to use. Using real-life examples, it discusses practical considerations for balancing performance, scalability, and reliability.

Russell, John. ACM SIGDOC (2001). Presentations>Information Design>Documentation

Follow us on: TwitterFacebookRSSPost about us on: TwitterFacebookDeliciousRSSStumbleUpon