After the CMS Implementation Project

Much effort is focused, on the selection and subsequent implementation of a content management system (CMS). While it is obviously vital to ensure that the initial implementation project is successful, this is only the beginning of an ongoing commitment to growing and enhancing the use of content management throughout the organisation.

Robertson, James. CM Briefing (2004). Articles>Content Management>Project Management>Workflow

An Agile Review Process for Technical Documentation

Documentation teams need a fast and effective review process to move forward on their projects and deliver quality, timely content. Reviewers, may they be SMEs (Subject Matter Experts) or key organization authorities, are usually extremely busy and have limited time (or interest) to review documentation. Interesting dilemma, no?

Talbot, Fabrice. LiveTechDocs (2008). Articles>Documentation>Agile>Workflow

Applying Software Development Methodology to Developing Help Systems  

Help systems have become an important part of the Technical Communicator’s repertoire. If we as communicators approach developing help systems in the same way we approach writing paper documentation, we miss the advantages of using software development methodology.

Nurczyk, Susan V. STC Proceedings (1997). Presentations>Documentation>Workflow

Audience Profile Sheet  

A form for coding users' interaction with a written document.

Markel, Mike. Bedford-St. Martin's (2001). Design>Usability>Workflow

Betriebswirtschaftliche Lüsungen zur Kostensenkung Technischer Dokumentation

Die meisten TD-Verantwortlichen besitzen einen technischen Hintergrund. Daher verwundert es nicht, dass sie Lösungen für Kostenprobleme ebenfalls in der Technik suchen: Datenbanken, Content Management oder Translation Memory. Doch die Investitionskosten sind hoch. Und oft dauert es Jahre, bis sich entsprechende Systeme amortisieren – wenn überhaupt. Ein Betriebswirtschaftler würde das Problem anders lösen: ohne Technik und ohne Investition, durch gezieltes Setzen von Prioritäten und mit optimierten Prozessen. Bewährte Ansätze aus der Betriebswirtschaft gibt es viele, denn andere Unternehmensbereiche leiden unter genau denselben Kostenproblemen. Dieser Beitrag zeigt die wichtigsten Methoden und gibt Beispiele für deren Anwendung in der Technischen Dokumentation.

Achtelig, Marc. indoition engineering (2006). (German) Articles>Management>Project Management>Workflow

Brainstorming and Storyboarding

The whole idea of “brainstorming” is to get ideas on paper. No particular order or structure, just get them ideas down. All you need is a quiet room, a clock, and pencil and paper. The procedure is simple: think about the subject and write down every idea that pops into your head within a set time.

Tech-Writer. Articles>Writing>Workflow

Building a Project Site

Managing a Web site project typically does not follow any clearly defined methods or standards of practice. Although there is a lot of 'how to build a site' information out there, very little on how to manage a Web project actually exists. But a project site could be just the answer you are looking for.

Leonard-Wilkinson, Theresa A. W-edge Design (2001). Design>Project Management>Web Design>Workflow

Building with Rusted Nails

We can compare web design and development to the process of building a house or a structure. The development of every web site has a process that these craftsmen must follow in order to achieve the finished structure. These phases are generalized and somewhat vague at times, while some may even be grouped or varied in name, but they are all essential steps in each web construction.

Finck, Nick and Peter Fielding. Digital Web Magazine (2001). Design>Web Design>Workflow

Calling for Backup

Writers, of course, seldom find themselves in life-and-death situations. However, the way in which a writing project is managed can often mean the difference between a project’s failure and success. For writers managing a project, obtaining backup consists of two issues: making sure someone can continue your work if something prevents you from doing so yourself; and knowing how to get help when you can’t keep your head above water.

Holland, Anton. Writer's Block (1995). Articles>Writing>Workflow

Centralized versus Distributed Organizational Structures  

The nature of a corporation and its product line(s) influences the optimal structure for your information-development organization. When lines of business are unrelated, information-development organizations may best function independently; when lines of business are interrelated, the groups need a unified strategy. While favored by product developers and business leaders, distributed structures can produce inconsistent information quality to customers. Centralized organizations can meet customer needs, but they are often perceived as focusing on publication quality rather than content. The best solution may be a hybrid structure that takes advantage of the strengths of both.

Hackos, JoAnn T. STC Proceedings (1999). Articles>Information Design>Workflow

Commenting on PDF Comments

If your response to the question 'How do you use Acrobat comments?' is a mumbled 'No comment,' then listen up. Comments and annotations are some of the most powerful ways in which Acrobat can streamline your creative workflow. Here are some tips.

Dennis, Anita. Creative Pro (2003). Design>Document Design>Workflow>Adobe Acrobat

Creative Brief  

A template to provide a brief description of the project. It should outline the objectives, audience, and assumptions for the project and details the creative concept the team intends to use moving forward. This document should accompany the materials for the Conceptual Design Review. Information should be filled in to give an overview to project reviewers who may not be intimately involved in the project. Differs from project overview in that this is specific background information related to design constraints, concerns and other information directly relating to the solution presented for review. The Creative Brief can also be used to inform outside firms about a project when brought in for consulting.

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

Data Collection in the Palm of your Hand: A Case Study

Mobile computing devices, which are commonly known as either personal digital assistants (PDA) or personal information managers (PIM), are an emerging technology that has the potential to be very useful in specific areas of computing.  One area in which mobile computing devices are gaining favor is in data collection, especially in places where larger computers are impractical.  While the use of these devices as a data collection tool is not a new idea (see Drury, 1987), it has been a bit slow to take off.  However, recent advances in this area of technology have allowed the gap in functionality between mobile computing devices and personal computers to be closed to such an extent that these devices may be considered to be as functional in many ways as a laptop or palmtop computer for collecting data.  In fact, the conversion of paper and pencil forms such as surveys, questionnaires, and assessments to these devices may be considered a next logical step in the use of mobile computing devices.

Spain, Kelly and Chad Phipps. Usability News (2000). Articles>Usability>Workflow>PDA

Datensicherung und Archivierung

Many computer users ignore the risk of data loss - until it is th late: Imporant Data have vanished. Who then desperately seeks advice in any of my mailing lists might get my try answer: "Simply restore from your last backup." OK, I do confess: This might contribute to a nervous break down. So better be prepared!

von Obert, Alexander. Techwriter.de (2003). (German) Articles>Computing>Workflow>Security

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 Designers' Outpost: Capturing and Interacting with Design History

In a high-tech field like web design, we might expect to find computer-savvy practitioners accomplishing all their work with the click of the mouse and a stroke of the keyboard. However, in our studies of the early stages of web design, we found that good ol’ pens, paper, walls, and tables were the primary creative tools.

Klemmer, Scott. Boxes and Arrows (2002). Design>Web Design>Workflow

Designing an Effective Review Process  

Review processes can easily become frustrating and complicated. Hart shows how to create and revive a review process that can be tailored to the needs of your situation.

Hart, Geoffrey J.S. Intercom (2006). Articles>Publishing>Editing>Workflow

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 Customer-Centered Organizations

Even with the present downturn in the economy, more companies, from new media to established banks, have larger usability and design teams than ever before. Should we be content that we have come so far?

Zapolski, John and Jared Braiterman. Boxes and Arrows (2003). Design>User Centered Design>Workflow>Usability

Designing Intersection Flows

When forms give users the option to continue in two or more alternative directions, such as registering as a new customer or signing in as a returning one, unfortunate users will take the wrong turn if it isn't unmistakably obvious which way they should go. In this article, we'll take a look at a few intersection flows that have caused users problems.

Olsen, Henrik. GUUUI (2005). Articles>User Interface>User Centered Design>Workflow

Developing a Departmental Style Guide

As a technical writer, you may be asked to develop a style guide for the hardcopy and online documents you produce. Sounds easy enough. After all, commercial style guides and, potentially, examples shared by your colleagues should provide enough information to get you started. In researching your task, though, you may find a variety of definitions and explanations of what a style guide is and why companies use them. What's more, you many find that style guides don't seem to have consistencies among them that can help guide you in developing one.

Weber, Jean Hollis. TECHWR-L (1998). Articles>Style Guides>Workflow

Developing a Personal Tagline

Part of professional development involves recognizing your strengths and learning how to express it to others. It is a helpful exercise to develop a tagline for yourself, in the same way that professionals in a previous generation were encouraged to develop a mission statement. With shortening attention spans, today's professional needs only a few-word tagline to fit in the sound bite of management's smaller time slots. Beyond what Chris Benz would call shameless self-promotion, having a personal tagline keeps your career development focused and on track.

Albing, Bill. Carolina Communique (2007). Careers>Business Communication>Workflow