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

Developing a Project Life Cycle for Technical Publications  

Having a technical publications project life cycle (pLC) that parallels an organization's product life cycle (PLC) greatly facilitates its adoption by engineering or development organizations. A technical publications project life cycle relates major documentation project management strategies, tasks, and deliverables to the same model used by technical organizations to control product development in an efficient and cost-effective manner. Some technical organizations perceive the documentation development process as being “intrusive” into the product development process, particularly during the Implementation Phase of the PLC. Communicating a technical publications pLC to these organizations early in the PLC eliminates this misperception.

Le Vie, Donald S., Jr. STC Proceedings (2003). Articles>Documentation>Project Management

Developing the Specification for a Document

Between 25-30 percent of the overall writing time is typically devoted to developing the document specification, meaning how the document will be formatted and actually present the information. This is true even when the organization has a style guide with a prescribed format, but no “standard” for documentation overall. Although this may seem an inordinate amount of time and effort on the front end, before getting any information onto the paper, it is far more cost-effective than spending unplanned time rewriting and reformatting the document late in the production process.

Tech-Writer. Articles>Writing>Project Management>Technical Writing

Developing Tools to Manage Projects  

Coordinating the resources and tasks involved in a large documentation development effort requires the ability to gather meaningful project information at critical junctures so that appropriate decisions can be made. Project managers need the right tools to help them make sense out of the sometimes overwhelming and chaotic flow of project activities. When appropriate tools are not available, documentation project managers must adapt and invent to obtain what they need.

Harr, Robert G. STC Proceedings (1993). Articles>Management>Project Management

Document Planning Checklist

You need to anticipate the lifecycle of technical publications in advance so that all areas related to the final delivery are covered. These include issues such as costs, production, dissemination and archiving.

Klariti. Articles>Project Management>Planning

A Documentation Database for Managing Time and Costs  

Keeping track of a technical writing team’s time can be a tedious task, especially when that time has to be charged to various internal departments. Using Lotus Notes™ (Lotus Development Corporation and Iris Associates, Inc.), we developed a relational database to track this information. This database uses a single form for all documentation status inputs. Then it summarizes the data in a variety of view. Separate forms track SEI statistics and simplify department employee time administration.

Lang, Darice and Debra Ricks. STC Proceedings (1994). Articles>Documentation>Project Management

Documents That No Project Cannot Be Without

Short deadlines force project teams to quickly design, test, and release the product with little or no design documentation. If these documents are written, they generally are not well-written and are not comprehensive. The fact of the matter is that most project teams do not have enough staff to design the product, let alone write and manage documentation. This situation creates an ideal opportunity for technical writers to assist the project team in more ways than writing a user guide.

Dick, David J. Carolina Communique (2008). Articles>Documentation>Project Management>Collaboration

Easing Into Agile Modeling

Agile modeling started out fairly complex and it grew a bit into its current form.

Ambler, Scott W. Agile Modeling (2006). Articles>Project Management>Agile>Collaboration

Easy Tools for Documentation Management  

The use of three simple tools can assist the documentation manager, from start to finish, on any new project. A revamped pubs plan, a new concept with engineering worksheets, and a matrix of modularized information are all utilized with a slightly new twist. The Pubs Plan is redefined to help you launch your project with a team approach, identifying issues, and proposing solutions. The Engineering Worksheets list all the critical pieces of information your writers/illustrators need for each component of the product. These pieces of information are then tracked by completion date on an Information Matrix. These documents work together as complimentary management tools that can be easily developed and scaled to the complexity of any project.

Shumate, Chona E. STC Proceedings (1999). Articles>Documentation>Project Management

Empathize with the Writer    

It is my firm belief that every technical writer is passionate about her work and would put in her best efforts to deliver high quality. If you are a manager or an editor and are shaking your head in disagreement, think again. Why would someone want to submit a work of poor quality?

Lawrence, Prema. International Journal for Technical Communication (2006). Articles>Writing>Project Management>Technical Writing

Estimating Scope and Schedule for a Help Project  

During this session, we will learn how to create a topic list to determine project scope, and then we will begin to calculate how long it will take produce all of these topics. When we’re done, you will have a methodology for doing this for your own project.

Deaton, Mary M. STC Proceedings (1997). Articles>Project Management>Documentation>Help

Estimating Scope and Schedule for Help Projects  

Three steps to a more accurate Help schedule.

Deaton, Mary M. STC Proceedings (1996). Articles>Project Management>Documentation

Estimating Time and Cost for Policies and Procedures Projects  

Estimating time and cost for a policies and procedures project can be an adventure in guessing and a ticket to grief. However, planning with a detailed checklist and list of assumptions can you help create a more realistic estimate, please your client, and protect your sanity and pocketbook.

Escoe, Adrienne. STC Proceedings (2003). Articles>Documentation>Project Management

Everything in Moderation: Using Content Units to Manage UX

I’ve found that separating client requests into content units removes uncertainty and offers clearer direction, while helping your client recognize each individual request as a deliverable, requiring assignments and responsibilities. To do this, I follow a four-step process that helps delineate what content units each section of a Web site must cover—as opposed to content that acts as filler, or filler units.

LaFerriere, Keith. UXmatters (2008). Articles>Project Management>Planning>User Experience

Facets Are Fundamental: Rethinking Information Architecture Frameworks    

This article presents three problems with existing information architecture frameworks. First, they are too focused on organizing information based on topic. Second, they treat facets as a supplemental form of classification. Third, they conflate the organization and representation of information. Analysis of these three problems suggests that information architects should provide navigation systems and user interfaces'based on an underlying framework of faceted classification'that allow users to flexibly navigate through complex information spaces in the service of particular tasks and goals. To this end, this article introduces a faceted classification framework, and provides an example of a model framework, called 'Facets are Fundamental' (FaF). The purpose of the FaF framework is to explicitly designate faceted classification (rather than a hierarchical classification) as the starting point of the IA development process. Both of these approaches encourage information architects to employ non-topical methods for organizing and representing information.

Crystal, Abe. Technical Communication Online (2007). Articles>Information Design>Project Management

Featuritis (or Creeping Featurism)

Featuritis or creeping featurism is the tendency for the number of features in a product (usually software product) to rise with each release of the product. What may have been a cohesive and consistent design in the early versions may end up as a patchwork of added features. And with extra features comes extra complexity.

Soegaard, Mads. Interaction-Design.org. Articles>Usability>Interaction Design>Project Management

A Few Good RSVP Tools: Online Registration Options for Free Events

When you're planning a free event, it's hard to justify paying a lot of money for online registration software--but email or Evite can be frustrating. Happily, other choices exist. We talked to seven nonprofit technology experts about useful and affordable (or free!) options for collecting RSVPs for free events.

IdealWare (2006). Articles>Project Management>Software

Five Levels of Agile Planning: From Enterprise Product Vision to Team Stand-up  

Existing agile methods often focus on small, single-team projects and overlook the broader impact of large, multi-team and multi-year projects. This paper outlines a distinct planning framework that has been used successfully in large-scale agile software development projects and relies on five levels: product vision, product roadmap, release plan, sprint plan and daily commitment. Each of the five levels of planning addresses the fundamental planning principles: priorities, estimates and commitments. In this paper, the main agile principles are introduced, as well as the Lean principles upon which the agile methods are built. One of those Lean principles, Muri, or overburdening of people, is addressed through the extension of the agile planning process. The extension of the most used agile planning technique (iteration planning) is described in detail, both the motivation for the extension as well as the collaboration practices behind each planning level. In the final chapter, the impact of product complexities on the planning process is evaluated, and a solution to create a smooth flow in the planning/delivery cycle is presented.

Smits, Hubert. Rally Software Development (2007). Articles>Project Management>Agile

Five Questions to Ask Your Web Development Team

As a client or manager responsible for a web development project you don't need to know anything about how a standards based web site is created. However you do need to know that your project is addressing these five important issues.

Allsopp, John. Western Civilization (2005). Articles>Web Design>Project Management>Standards

Fixed Quotes and Broken Promises

How to tie down the details of a project and protect yourself from unexpected changes that can drag a 'peach project' into the 'pits of despair and financial ruin.'

Juillet, Christopher. Boston Broadside (1990). Articles>Project Management>Planning

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

Front and Back Matter Notes

Any document has three distinct parts: front matter; text; and back matter and reference material.

Tech-Writer. Articles>Publishing>Project Management

Gantt to Glory: Evolving from Project Management to Successful Web Operations

Is the sheer possession of a PMP intended to be the Holy Grail of successful web projects, known to fail at a startling rate, or simply a way to divorce oneself from whatever outcome may result from the web project?

Podnar, Kristina. Content Wrangler, The (2008). Articles>Web Design>Project Management>Planning

A Gentle Introduction to Object-Oriented Programming  

Object-oriented (OO) programming helps writers and programmers use real-world paradigms. By understanding some basic terminology of OO (classes, instances, and messages), the writer can feel more at ease with OO concepts. A glossary and suggestions for further reading are included.

Chacko, Rajah Y. STC Proceedings (1994). Articles>Project Management>Programming