Deciding What Needs to be Done

Before you begin editing a document, you need to analyse it and plan what needs to be done. The exception is when your job is strictly limited (by your supervisor or the client) to correcting only the glaring errors of spelling, punctuation and grammar (a 'light edit'). There is no point to attempting a more substantive edit if doing so will only get you into trouble (or if the client won't pay you for the time you spend).

Hollis Weber, Jean. Technical Editors Eyrie (2001). Articles>Editing>Project Management

Decision Making: A Missing Facet of Effective Documentation  

The old school of software interface design and document writing took the view that if the user could find the information someplace, the user could use it. But simply sticking in details ignores how readers access and process information.

Albers, Michael J. ACM SIGDOC (1996). Presentations>Documentation>Management

Decision Support Systems for Environmental Management: Web-Based Communication Modules to Enhance Public Participation  

Nature provides important basic functions for society. Expert systems for integrated knowledge management, so-called decision support systems (DSSs), are tools to manage vegetation, air, soil, and water, and to assure functional integrity of ecosystems, e.g. river basins. Over the past decade sustainability has became the accepted norm to manage our life support resources. This concept is based on responsibility to the “Other” and on participatory consensus-forming dialogues leading to stakeholder models; before, the predominant school of thought has been utilitarianism. Scientists, engineers and technical communicators are challenged to develop feasible technologies to facilitate management, for example to supplement DSSs with virtual libraries and web-forums.

Kaempf, Charlotte. STC Proceedings (2001). Presentations>Web Design>Management>Participatory Design

Defining 'Value-Adding Work' of In-House Information Development Groups  

Many in-house information development groups are redefining their role (or seeking to justify their existence) around the concept of 'value-adding work.' But which tasks are value-adding? Finding an answer to this question is critical for the survival of information development groups. Unfortunately, there is no easy, 'one size fits all' answer, because the response depends largely on your point of view. Thus, deciding what is and isn't value-adding may require technical communicators to do more project-by-project task, audience, and media analysis than ever before.

Collins, William L. STC Proceedings (1998). Careers>Content Management>Information Design>Content Strategy

Defining a TC Body of Knowledge

First of all, a profession cannot be recognized as a profession until it is defined as such. Engineers, for instance, have a body of knowledge they must master before they can practice as engineers, whether structural, electrical, or mechanical. Although technical communicators may not yet want such a highly codified and subdivided set of skills and practices, we do need an authoritative place to find answers to that eternal question: "What do technical communicators do, anyway?"

Hart, Hillary. Between the Lines (2008). Articles>TC>Knowledge Management>Body of Knowledge

Defining Benchmark Questions for Great Results

Part of the challenge of determining the questions to ask during benchmarking is to match the questions to the purpose of the study and the outcomes you are trying to achieve. Below is a breakdown of some of the issues regarding benchmarking questions that need to be addressed before beginning a benchmarking exercise.

Sinickas, Angela D. Sinickas Communications (2002). Articles>Management>Communication>Assessment

Definition of Information Management Terms

There is considerable confusion in the marketplace regarding the definition of various information management terms. The scope and role of specific information systems is particularly blurry, in part caused by the lack of consensus between vendors. With the aim of lessening this confusion, this briefing provides an at-a-glance definition of terms for a range of information systems.

Robertson, James. Step Two. Articles>Content Management>Single Sourcing>Glossary

Delegating for Results

I presented a program recently that gave tips for becoming a more effective delegator. The tips explained the benefits of delegation and how to overcome common barriers. Because you can use these tips whenever you are leading a chapter, a committee, a team, or a department, I want to share them with you. If you are not delegating properly, you are making your own life more difficult. In turn, your subordinates suffer because their interests as well as their talents are being overlooked, however unintentionally.

Laurent, J. Suzanna. Carolina Communique (1999). Careers>Management

Delivering Bad News Effectively (and Other Useful Communication Skills for Managers)  

Learning how to communicate effectively when people problems arise is a key to your success as a manager. To make the process easier for yourself, you should learn to set clear expectations of your employees, make specific observations of their work and behavior, conduct timely communication with them when problems arise, listen closely when they respond, and schedule a follow-up meeting after the crisis has passed.

Giammona, Barbara A. STC Proceedings (1999). Careers>Management>Communication>Collaboration

Delivering Content That Makes a Difference  

Local control facilitates informed decision-making by giving users access to highly relevant and timely information.

Trippe, Bill. Gilbane Report (2004). Articles>Content Management

Demonstration of an XML-Based Content Management System Implementation  

The impact of XML and content management on the field of technical communications is no longer just a speck on the horizon. This paper presents techniques and observations from the trenches of a real-world XML-based content management system implementation that is being used to develop and publish print and online documentation at a prominent software company.

Bookless, Jody, Annette Marx and Scott Davis. STC Proceedings (2005). Articles>Content Management>XML

Demystifying Information Modeling  

The information model is a framework for organizing all the information people need.

Hackos, JoAnn T. ComTech Services (2002). Design>Information Design>Project Management>Metadata

The Design and Development of a Project-Oriented Information System    

In this paper, the idea of building a project-oriented information system based upon a specialized information database was discussed. It attempts to provide tools for helping researchers use Internet resources effectively in the course of their research. Based on this idea, a web-based project-oriented information system was constructed. The paper systematically expounds the design and development process of the project-oriented information system. Furthermore, examples of utilizing the project-oriented information system to obtain useful information and suggestions for specific projects were described. According to our discussion and utilization of the system, we believe that building a project-oriented information system can help researchers with their research projects.

Zhao, Yuehong, Chao Liu, Hao Wen, Hezhen Zhang and Zhihong Xu. Data Science Journal (2003). Articles>Project Management>User Centered Design

Design Review Checksheets  

Useful checksheets with questions for consideration by the design team and reviewers when reviewing work at different stages of the process. There is a checksheet for Concept review, UI/interaction design review and Visual design review. Has space indicated for approvals and signature sign off by selected approvers. These sheets are great for tracking the progress and making sure key people approve and sign off on each step.

Malone, Erin. AIfIA (2003). Resources>Project Management>Workflow

Design Review Process  

A template to capture the dates in the Design Review Process and key milestones and stakeholders.

Malone, Erin. AIfIA (2003). Resources>Project Management>Workflow

Design Scope  

The Design Scope template should outline the general aims and goals of the project design and lists the major deliverables and milestones. To be completed by the experience design team lead.

Malone, Erin. AIfIA (2003). Resources>Project Management>Workflow

The Design Spectrum

'Design' encompasses a very wide spectrum of disciplines and applications, which address an enormous range of different problems. When designing a product, the techniques and priorities a designer should use change according to its purpose.

Hunt, Ben. Web Design From Scratch (2006). Design>Project Management>Methods

Designing an Information Set for Single-Sourcing  

The single source in a robust single source system is not any one of the outputs that may be created from that source. The single source is an information set from which many outputs may be created. Designing an information set is different from designing a document. Greater structure is required, and that structure must be available to the process that creates information products as output, not simply to the reader. A good information set design involves creating a data model, mapping information relationships, and defining patterns of change.

Baker, Mark. STC Proceedings (1999). Design>Content Management>Single Sourcing

Designing and Conducting Effective Role-Play Activities  

Role play activities allow learners to test new skills and apply them to the real world. Effective role-plays must be carefully planned and conducted in order to be effective. This article offers advice on creating and conducting role-play activities, and transferring their learnings to the real world.

Swan, Bonnie J. and Carolyn Luttrell. STC Proceedings (2005). Careers>Management

Designing and Planning Modular Content Projects  

Modular writing involves writing, labeling, storing, and assembling content modules. Read about how to design and plan a modular writing project and how this writing system affects traditional roles and responsibilities within a publications team.

O'Connor, Virginia. Intercom (2006). Articles>Content Management>Workflow

Designing for Limited Resources

When resources are limited, the design must be optimized to make the best use of all resources. To account for this complexity, it is important to have a clear understanding of both sides of the design equation—what you have to work with and what you are trying to build.

Quinn, Laura S. Boxes and Arrows (2004). Design>Web Design>Project Management

Designing for Web Services

Many technology companies, consultants, and academics are hyping the future of Web services. But how will this background transfer of data between applications affect the user experience?

Lombardi, Victor. New Architect (2002). Design>Web Design>Content Management>User Experience

Designing Single Source Materials  

Timelines for developing documentation are getting shorter and budgets are getting smaller. This means that we have to find more efficient ways of developing documentation. One way is to consider single-sourcing your information for multiple media (paper, online), multiple types of documentation (user documentation, Help, training), multiple users and reuse of information for multiple products. While this process takes a lot of up-front planning it can significantly decrease your costs and development times. This session looks at the process for designing and creating single-source materials for multiple media, users, or types of documentation.

Rockley, Ann and JoAnn T. Hackos. STC Proceedings (1999). Presentations>Content Management>Single Sourcing

Designing Wearable Performance Support: Insights from the Early Literature    

According to Gery (1991), an electronic performance support system (EPSS) is an electronic environment available to and easily accessible by employees that is structured to provide online access to all information to permit them to do their jobs with minimal intervention by others. Why do we assume that this support must be provided on a computer? If effective performance support must be 'available' and 'easily accessible,' how can designers provide support to people whose jobs require mobility? Such jobs include (but certainly are not limited to) supervising a manufacturing operation, inspecting foods, and repairing equipment. A designer for any EPSS being developed to support jobs such as these would have to take the employees' mobility into account.

Gobert, Danielle. Technical Communication Online (2002). Design>Content Management>Wireless Web