Developing Documentation Process  

This paper defines a good manual to have a good balance in quality, cost (close to estimation, not over), and delivery (on time schedule). Analyzing our past problems, we have been developing documentation process to control these three factors through the following: working as a team, standardizing an estimation method, and standardizing an evaluation system.

Suzuki, Akihiko. STC Proceedings (1993). Presentations>Documentation>Workflow

Development of a Model For Managing Organizational Knowledge  

The proliferation of interest in “knowledge management” in the last few years is a reflection that information has finally gained visibility as a major corporate asset. Furthermore, sharing information across the organization to support greater learning and competitiveness has resulted in moving to the next level of information management (IM)—knowledge management. Those of us who have been in the information business for a while have to contain our amusement as we have seen a society preoccupied first with data (anything that is observed, measured, counted, or collected), then information (organized data), now knowledge (selected information), and, perhaps next, wisdom (integrated knowledge).y´ As Thomas Stewart defines it in Intellectual Capital: The New Wealth of Organizations, “Intelligence becomes an asset when some useful order is created out of free-floating brainpower—that is, when it is given coherent form (a mailing list, a database, an agenda for a meeting, a description of a process); when it is captured in a way that allows it to be described, shared, and exploited; and when it can be deployed to do something that could not be done if it remained scattered around like so many coins in a gutter. Intellectual capital is packaged, useful knowledge.”

Ashdown, Barbara and Kathy Smith. OSTI (1999). Articles>Knowledge Management>Workflow

Documenting the Flow of Rule-Based Programming in Expert Systems  

With the spread of new technology, technical communicators face interesting new challenges for solving documentation problems. One area of software development that technical communicators are increasingly becoming involved in is that of rule-based expert systems. Because of their complexity, both the systems and their documentation can be difficult to maintain. Technical communicators can solve some of these maintenance problems by flow-charting only the chaining structure of the rule-base design.

Glover, Kyle S. STC Proceedings (1994). Articles>Documentation>Programming>Workflow

Documenting While on Patrol    

While the jobs of Mary Clouse and the rest of the Security and Documentation Unit of the New York State Senate Technology Services department aren't as glamorous as those of the senators themselves, they ensure that the Senate can use its automated systems to conduct its daily business smoothly, efficiently, and securely.

Clouse, Mary. Intercom (2008). Articles>Documentation>Workflow

Edit and Revision

If you’ve done any writing at all, you’ve experienced the dilemma of selecting the right “level” for the project. In academic and technical writing there tends to be less concern about this, though there should be. In my opinion, given two cents, the more natural my writing seems, meaning more as it would be spoken, the more comfortable it will be to the reader. It’s unclear to me whether it takes more time and effort to write at this level, but it serves readers well and that’s the key. Edit and revision is the key to excellence.

Tech-Writer. Articles>Editing>Workflow

Emphasizing Internal Technical Communication  

Internal communication activities frequently have a lower priority over external communication efforts because they do not directly support current and future customers. Many organizations do not realize that internal communication activities can be just as critical to delivering their products and services. The Research and Development Division at SAS has taken a unique approach to facilitating internal knowledge transfer by dedicating a department to this effort. We’ve found that we must frequently evaluate the needs of our internal audiences, and that we can successfully employ technologies and deliverables often used for external communication to support our user's needs.

Brown, Sandy, Lindsey Greene, Ronald A. Statt and Kathleen Walch. STC Proceedings (2003). Careers>Management>Workflow

Enhancing The Review Process: Giving And Receiving Constructive Feedback  

Clear, positive feedback can contribute significantly toward improving the quality of printed and on-line documentation. Wizen feedback is negative, unclear, or incomplete, however, the accuracy and quality of a document can suffer, and misunderstandings between colleagues can result. Those who are responsible for reviewing documental ion can enhance that process by knowing what type of feedback to provide and how to offer it in a clear and constructive way. Those who request feedback on their documentation projects also can enhance the review process by clearly identifying the project scope and specifying their evaluation needs to their reviewers.

Pritchard, Laurie N. STC Proceedings (1994). Presentations>Documentation>Workflow

Flowcharting Performance-Based Processes and Procedures  

This session distinguishes between analytical- and performance-based flowcharting of process and procedures. The session will present why, how, and when flowcharting is considered superior to text alone, along with defining flowcharts and symbols. The session distinguishes between processes and procedures and the various styles, formats, and trends that have developed historically primarily due to different origins, purposes, and technologies. The session also presents recommended standards for creating flowcharts, and addresses issues on tools, training, and trends.

Urgo, Raymond E. STC Proceedings (1995). Articles>Project Management>Planning>Workflow

The Freedom of Fast Iterations: How Netflix Designs a Winning Web Site

The designers of Netflix.com have a smashing success on their hands, but we didn't find them resting on their laurels. They want to get even better, and for them that means iterate, iterate, iterate. Netflix isn't the only company using a fast iterative design approach. Google has also gained attention for their unorthodox design methods, with many people complaining that they have a huge stable of products, but only a few they've designed well.

Porter, Joshua. User Interface Engineering (2006). Articles>Web Design>Usability>Workflow

Group Project Peer Evaluation Form  

Use this form to evaluate the other members of the group. Write the name of each group member in one of the columns, then assign a score of 0 to 10 (0 being the lowest grade, 10 the highest) to each group member for each criterion. Then total the scores for each member. Because each group member has different strengths and weaknesses, the scores you assign will differ. On the back of this sheet, write down any comments you wish to make.

Markel, Mike. Bedford-St. Martin's (2001). Careers>Workplace>Workflow

Handheld Devices and the Flow of Functionality

Handheld devices and small appliances pose a unique challenge to the interface designer. The blur between user interface and functionality (interface vs. interaction) is even more pronounced in these environments. The interface of any small device is extremely important; yet, more than ever, the necessity to build in exactly (and only) what is required by the user is extremely important!

Ferlazzo, Ellen Lawson. Sprezzatura Systems (2002). Articles>User Interface>Workflow>PDA

How Design Documents Enhance Information Product Development Process Quality  

Panelists from LSI Logic Storage Systems review their company's approach to enhancing process quality by using design documents as process enforcement and project-planning tools for planning the development of information products (IP). Hear how effective planning solves problems that occur during the IP development process and how capturing the planning elements in design documents helps solve role-based problems for developers, editors, and managers. Discuss the many problems design documents help project teams solve: they help developers solidify the IP development task sequence, they help editors define the rhetorical context, and they help managers reduce the cost of rework.

Burroughs, Dia H., Randy Clark, Sylvia McCombs and Tony Washington. STC Proceedings (2004). Articles>Documentation>User Interface>Workflow

Improving Management of Your Business

All companies have business processes that can be improved. Most companies can benefit from automation or further automation of solutions.

Pires, Halstatt. Ezine Articles (2006). Careers>Management>Project Management>Workflow

Improving User Workflows with Single-Page User Interfaces

While the sheen has already begun to wear off the buzzword Ajax a bit among Web application designers, RIAs are bigger than ever with our clients and their customers.

Willemsen, Joost. UXmatters (2006). Design>Web Design>Workflow>Ajax

Information Design Process  

Covers the stages in the information design process of: discovery, analysis, prototyping and review.

Deshpande, Shashank. STC India (2003). Presentations>Information Design>Workflow

Information Process Reengineering  

Information process reengineering means making fundamental changes to how you create, maintain, deliver, and distribute information so that you meet business objectives. It is not simply incorporating new tools or technologies into a current information development and distribution environment. The changes made as a result of reengineering are much broader and more significant; they are revolutionary. The phases you move through as you reengineer are not revolutionary. In fact, to many the phases are quite familiar: design, pilot, refine, roll out. It’s not how you approach reengineering but rather what you end up with when you’re done that revolutionizes your business.

Currie, Cynthia C. and Thomas J. Vallone. STC Proceedings (1994). Articles>Information Design>Workflow

Integrating Information Architecture into Your Information Development Processes  

The most critical and time-consuming aspect of your decision to adopt information architecture as a backbone of your information development process might not be the adoption of new guidelines or tools, but moving the mindset and culture of the organization so that it can operate effectively in the new paradigm. Using examples from real experiences, the authors of this paper describe the organizational 'culture shock' that can occur when a team or organization moves to an information-architected model for content delivery--the likely pitfalls and some ways to overcome them.

Kowalski, Lee Anne, Andrea Ames, Michelle Corbin and David McCaleb. STC Proceedings (2004). Articles>Information Design>Workflow

Introduction to the Diagrams of UML 2.0

Understanding the thirteen diagrams of UML 2.x is an important part of understanding OO development. Although there is far more to modeling than just the UML the reality is the UML defines the standard modeling artifacts when it comes to object technology.

Agile Modeling. Articles>Project Management>Workflow>UML

It's All in the Process  

Information design, according to practitioners like the Berlin-, London-, and San Francisco-based firm MetaDesign, is about more than just conveying complex information clearly. To work well, it has to be a process in which designers and clients act as partners.

Senechal, Ann. Adobe Magazine (1997). Design>Information Design>Workflow

Knowledge Management for Front-Line Staff

The front-line environment must be understood when implementing knowledge management initiatives.

Robertson, James. Step Two (2003). Articles>Knowledge Management>Workflow

Making Product Information an Integral Part of the Development Process  

Document inspections formalize the document review process and encourage the full participation of technical developers in the documentation development process. A document inspection consists of three parts: a briefing meeting, a desk review, and a recording meeting. At the briefing meeting, you state your requirements for the inspection process. During the desk review, the technical developers review your document. At the recording meeting, you review the comments made by the technical developers, and as a group decide on appropriate resolutions.

Hildebrand-Lund, Ruth. STC Proceedings (1996). Articles>Documentation>Workflow>Technical Writing

Making Yourself Part of the Team

Thoughts on how a contract technical communicator can become part of a development team, and set the tone for the writers who follow.

DMN Communications (2008). Careers>Advice>Workflow>Collaboration

Managing Content Hypergrowth  

To cope with a flood of assets, site owners turn to content management software. As they outgrow their “home brew” solutions, they buy packaged applications -- even though today’s products are immature.

Dalton, John P., Harley Manning and Katharine M. Gardiner. Forrester Research (2001). Articles>Content Management>Workflow

Managing Life Sciences Content

Life sciences have been called the least automated industry in the world, but some pharmaceutical companies, medical device manufacturers, and healthcare-related organizations are working to dispel that image by implementing targeted content management solutions aimed at shortening the amount of time it takes to get new products to market.

Rockley Group, The (2004). Articles>Content Management>Scientific Communication>Workflow