An Integrated Approach for a Model Based Document Production and Management

The primary aim of the research presented in this paper is to provide pragmatic solutions to the problems of integrity and consistency of document based information, describing a building throughout its life cycle. The research demonstrates the computer-aided generation of project documents via a construction project data model. The first research activity involved the development of a Construction Project Reference Model (CPRM) and a Document Reference Model, from which various Applied Document Type Models can be derived. The work concentrated on the French Full Specification Document: the CCTP (Cahier des Clauses Techniques Particulières), which is generated during the detail design stage. A generic Association Model was developed and used to index the CPRM’s concepts to the CCTP’s documentary elements supporting their description. Finally, the mechanisms enabling the generation of the project CCTP from the proposed structured reference CCTP are described.

Rezgui, Yacine and Philippe Debras. ITcon (1996). Articles>Document Design>Information Design

Intentional Learning in an Intentional World: Audience Analysis and Instructional System Design for Successful Learning and Performance    

How do we support successful, lifelong learners and performers and help them competently respond to rapidly changing opportunities in the 21st century. The answer to this question lies in how well we understand audiences differentiated by key learning differences and consider how these differentiations influence winning learning and performance. Historically, cognitive-rich explanations have tended to underplay the dominant impact of affective and conative factors on thinking and learning. Recently, these dimensions have gained considerable importance as contemporary multidisciplinary research has begun to demonstrate how intentions and emotions can influence, guide, and, at times, override our thinking and other cognitive processes. More importantly, research suggests that intentions and emotions are a dominant, powerful influence on learner success.

Martinez, Margaret. Journal of Computer Documentation (2000). Articles>Documentation>Instructional Design>Education

Is Your Website Poised to Deal With Its Growth?  

Every webmaster nourishes the dream that his or her website will make it the big way. This is very much human because people carry out any task in ardent hope. What is more human out here is that earthy fellows like us base our aspirations more on speculation rather than specific set of steps undertaken to bring the dream a bit closer to reality. And this is not all, particularly in case of growth of a site which brings newer problems in the wake of its growth. It cannot be disputed that you can probably get some good web hosting on economy price. But if you expect top of the line service on this price, acknowedge gracefully that your are just asking for the moon. Probably you are not catching up with wisdom that business needs decisive investments.

Azam, Rahbre. Amateur Writerz (2008). Articles>Documentation>Web Design>Technical Writing

Issues with Adobe FrameMaker Print to PDF

An issue that has come up over and over again on several FrameMaker and Acrobat/PDF email lists as well on the corresponding Adobe User-to-User forums is that of creation of PDF files. FrameMaker 5.5.6 and 6 have what looks like a convenient feature that is supposed to allow you to create PDF files via simply saving the document as a PDF file. I have gone on record as advising end-users not to use this approach for reliable creation of PDF files from FrameMaker documents under Windows and MacOS with FrameMaker 6 and earlier. Why do I most vociferously offer this advice and why doesn't the problem get fixed? And how SHOULD you create PDF files from FrameMaker?

Isaacs, Dov. Bright Path Solutions (2004). Articles>Document Design>Online>Adobe FrameMaker

It's a Colorful, Wired World  

Adobe® PostScript 3 printing systems offer a variety of new features for better, faster, Web-savvy printing. Here's an overview of what they are and how they're likely to affect you.

Nordling, Tamis and Wendy Katz. Adobe Magazine (1997). Articles>Document Design>Prepress

It's Not Enough to Say What it Does

All too often, developers think that documenting their new creations just means writing a detailed technical description of what it does. In a sense, they're explaining things to themselves. But what you really need to do is explain things to someone who's coming across your stuff for the first time.

McManus, Eamonn. Artima (2004). Articles>Documentation>User Centered Design

Karen A. Schriver: The InfoDesign interview

Karen Schriver is the author of Dynamics in Document Design: Creating texts for readers, an extensive, multidimensional portrait of what readers need from documents and of ways to integrate word and image in order to better meet those needs. She is the former co-director of the graduate program in technical communication and document design at Carnegie Mellon University. Her company, KSA Document Design and Research, helps organizations improve the quality of their paper and electronic communications through strategies based on research and best practices.

Bogaards, Peter J. InformationDesign (2005). Articles>Interviews>Document Design>Visual Rhetoric

Keeping Pace with Change

Documentation isn't the most fun part of design and IA, but does it have to be the most painful? Samantha Bailey looks at a tool that may help.

Bailey, Samantha. Boxes and Arrows. Articles>Documentation>Information Design

Let's Stop Writing Documentation and Start Working for the Users  

Nearly 20 years ago, the profession of technical communication began to focus on developing task-oriented documentation. Although task-oriented documentation has always been produced, particularly for consumer products, it was not the standard in the computer industry. More often, people writing about computer systems focused on the system rather than on the tasks people needed to perform. Systems-oriented documentation was the norm.

ComTech Services. Articles>Documentation>User Centered Design

Let's Stop Writing Documentation and Start Working for the Users  

Technical communication's long-time focus on task-oriented documentation has left customers with too many tasks and too much information; itï¿Âs time for a new approach. A user-centered approach reflecting a thorough understanding of users and how they engage the product is the surest route to effective documentation and training. To understand what users need, we need to get closer to them by spending time in their workplaces, watching them execute everyday tasks, and listening to them. Through this kind of ethnographic activity, we will become user experts, gaining credibility within our own organizations and our user communities.

Hackos, JoAnn T. STC Proceedings (1999). Articles>Documentation>User Centered Design

Little Machines: Understanding Users Understanding Interfaces    

This paper questions the ubiquitous practice of supplying minimalist information to users, of making that information functional only, of assuming that the Shannon-Weaver communication model should govern online systems, and of ignoring the social implications of such a stance. Help systems that provide fast, temporary solutions without providing any background information lead to the danger of users completing tasks that they do not understand at all. (Word will help us write a legal pleading, even if we have no idea what one is.) As a result, we have help systems that attempt to be invisible and to provide tool instruction but not conceptual instruction. Such a system presents itself as a neutral tool, but it is actually an incomplete environment, denying both the complexity and alternative (and possibly improved) modes of thinking about the subject at hand.

Johnson-Eilola, Johndan. Journal of Computer Documentation (2001). Articles>Documentation>User Centered Design>Usability

Making Help More Human, and Other Discussions

Discusses a number of trends in the technical writing world, particularly the need to make help more human by adopting conversational tones and addressing the angry/frantic state of the user.

Johnson, Tom H. and Heidi Hansen. Tech Writer Voices (2007). Articles>Documentation>User Centered Design>Help

Making PDFs Smaller

How can I reduce the size of several PDFs at once?

Rosenthol, Leonard. PDFzone (2003). Articles>Document Design>Software>Adobe Acrobat

Making Screen-Ready PDFs

Is there a quicker way of making screen PDFs from print-ready PDFs?

Miller, James. PDFzone (2003). Articles>Document Design>Software>Adobe Acrobat

Markup PDF Pages with Drawings

Using Acrobat, PDF has been established as a popular and user-friendly medium for collaborative workflows. Not only can you add sticky notes or highlight text, you can even draw polygonal or freehand annotations. This tip explains how.

Shea, Dan. PlanetPDF (2007). Articles>Document Design>Software>Adobe Acrobat

Marrying Digital and Paper Documents

The use of physical paper or digital files is not an either/or choice. The two are complementary. Currently, there are many examples of paper used as an interface to digital processes. The UPC found on items we buy and the barcoded labels on the packages we send are two prevalent examples. Many papers we use to reach our customers or to do our work within our organizations have at least one barcode.

Zukowski, Deborra J. e-Doc (2005). Articles>Document Design>Information Design

Merging Usability Practices with Document Design and Development    

Examines the phases of document development and describes how to incorporate them with usability techniques to ensure that your information products remain continually useful and valuable.

Filippo, Elizabeth G. Intercom (2007). Articles>Document Design>Usability

A Millennial Paradigm for Documentation: the Scroll!

Although some zealots have proposed eliminating printed information entirely in favor of online help systems, Adobe Acrobat files, and even e-books, discarding printed books may prove less effective than simply modernizing them. Scrolls are the logical successors to books.

Hart, Geoffrey J.S. Geoff-Hart.com (2001). Articles>Documentation>Information Design

Much Ado about Nothing, Part I: The Importance of White Space    

White space is a paradox: by definition it contains no information, yet it clearly communicates despite lack of content. Hart describes how to incorporate white space into the information design process.

Hart, Geoffrey J.S. Intercom (2008). Articles>Document Design

New Life for Product Documentation

Here are some 'truths' we've all heard: 'Documentation is just a band-aid for poor design.' 'Real users don't read manuals.' 'Super users never read anything.' 'Help doesn't.' But are they really true? I've seen some signs of life in the use of documentation for digital products recently.

Quesenbery, Whitney. UXmatters (2006). Articles>Documentation>User Interface>User Centered Design

Newsletter Design for Non-Designers  

Newsletter design comprises everything from column width and typeface to clip art style and paper color--where do you start? You don’t need to be a graphic artist to design an appealing newsletter—but you need to know the basic principles and how to apply them consistently. Consciously or not, every time you read something, you make judgments about its design. Was it easy to read or skim? Did the artwork seem appropriate? Were the page numbers easy to locate? In this workshop we will review these and other design elements and how to make them work for your newsletter.

Disch, Cheryl and Cheryl Lockett Zubak. STC Proceedings (1995). Articles>Document Design>Publishing>Newsletters

No More Lost Work, No Matter What You Use!

Create file versions on the Adobe Web Workgroup Server using your favorite Adobe application. Restore any version using Adobe GoLive.

Adobe (2003). Articles>Software>Document Design>Adobe GoLive

Non-Fatal Errors: Creating Usable, Effective Error Messages

It's often easy to identify what kinds of error messages don't help users, but it can be tricky to avoid them, and even more of a challenge to create the opposite: error messages that give users a clear indication of the problem, offer information to help them fix it, and provide tips on how to avoid the same situation in the future. This paper details the steps involved in creating understandable, helpful error messages, and suggests ways of communicating the value of good error messages to managers and executives.

Wilska, Emily. WritersUA (2004). Articles>Documentation>User Centered Design>Online

On My Little Planet...

Nobody reads user manuals for pleasure. And yet we all make our living from them, and hope that what we produce is at least useful, if not actually enjoyable

Bardez, Jean-Paul. TC-FORUM (2000). Articles>Documentation>User Centered Design

One Hundred and One Spots, or How Do Users Read Menus?  

Proceedings of a paper about how readers interact with designed documents.

Aaltonen, Antti, Aulikki Hyrskykari and Kari-Jouko Raeihae. Proceedings of the SIGCHI Conference on Human Factors in Computing Systems (1998). Articles>Document Design>Interaction Design>Usability