Evolving Concepts: Expanding Project Resources  

It is generally true that as large technical training and documentation projects evolve they place new and greater demands on existing resources. Although the intensity of the demand varies, it can usually be attributed to changes in the software application, to the addition of new learner groups, to the compression of existing schedules, and to the need for new training and documentation solutions. As projects become more demanding, resource allocation challenges become more sophisticated. Managers who bring big projects in within budget and on time, do so became they are able to allocate resources in creative, efficient, and effective ways.

Johanningsmeier, Kathleen A. STC Proceedings (1994). Articles>Documentation>Planning

How to Plan On-line and Paper Versions of a Software Manual

On projects for which you must produce both on-line and paper documentation, there are many things you should consider before you start.

Kozuma, Bruce. Boston Broadside (1991). Articles>Documentation>Project Management>Planning

Performing Publications Needs Assessments  

A publications needs assessment is a way to identify and analyze documentation and publishing needs for a project, group or company. The technical communicator can use these assessments to ensure that the proper documentation and publishing services are provided. This paper describes a four step approach to performing publications needs assessments.

Devlin, John T. STC Proceedings (1993). Articles>Documentation>Planning>Assessment

The Six Biggest Mistakes Project Managers Make with Documentation and How to Avoid Them

Professional business writers, such as technical authors, typically break a document down into small, discrete units of information, organised around a skeleton of topic headings. If you use this 'component' or 'modular' approach, you can plan and structure the document using the heading 'labels' that describe each section.

Pratt, Ellis. Cherryleaf (2007). Articles>Documentation>Planning>Project Management

Usability is Everybody's Business  

Different types of usability tests can be performed at different phases in the product development cycle for different reasons. Writers can plan and implement a usability test and then incorporate recommendations into their documentation, thereby improving its usability. You can improve the usability of your documentation by performing one or more types of usability tests, no matter the size of the product or the time frame involved.

Corbin Nichols, Michelle, Judith R. Fisher, S. Dawn Achee, Julia C. Stovall, David J. Dixon and Jane Emans Jesser. STC Proceedings (1993). Articles>Documentation>Usability>Planning

A Visual Methodology From Topic List to Storyboard  

When faced with an online or printed documentation project, many writers don't know where to start. On one hand, a large amount of information is waiting to be delivered to the customer. On the other hand, a number of important questions seem to require immediate answers. What development tools should the writer use? What are the advantages/constraints of the development tools? What delivery environments are going to be available? In reality, it's too early to answer these questions. Instead of making decisions about tools and environments, the writer needs to concentrate on the information that needs to be communicated and organize it for online presentation. What the writer needs is a methodology that makes it easy to visualize the information. If the information presentation is not visualized in a clear and logical fashion, the documentation product is not going to be a success, no matter how sophisticated the development tool and delivery media.

Hyman, Francine N. and Barton A. Evans. STC Proceedings (1993). Articles>Documentation>Planning

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

Why the Future of Documentation Belongs to Extended Markup Language?

XML, that is, Extended Markup Language, is the future of technical writing. There are TWO important reasons why that is so: XML is at the heart of “single sourcing” movement; and XML is a documentation manager’s dream since writing once and publishing many times drops unit production costs tremendously.

Akinci, Ugur. Technical Communication Center (2009). Articles>Documentation>XML>Planning

Starting Points with Quick Reference Guides: Gathering Before Designing

Dan Roam explains that drawing pictures can help you solve problems. He says the first rule is to “collect everything possible up front.” After collecting all your information, you then “lay it all out where you can look at it.” By laying out all the information, you can grasp the whole of it, make connections between various parts, see the important sections, and recognize patterns.

Johnson, Tom H. I'd Rather Be Writing (2009). Articles>Documentation>Information Design>Planning