back to homepage

proper documentation Free Articles

Successful Documentation Projects – Part 2 of 3 – ‘Specifying’

So you’re responsible for managing a documentation project. You know who your audience is, what they’re trying to achieve, how the product enables them to achieve it, and what the audience requires of the help. Now it’s time to spec out your intentions.

Read More

New Technical Writer: First Things to Do on the Project

You, a non-writer, have just been assigned to write the documentation for a product your company produces or markets. You may be stressed out about the assignment. Fear not! This article will get you started on the path to writing a successful document.

Read More

Losing momentum?

... 1. Are you losing momentum while others plan ahead? 2. Is your ... getting the action you want? 3. Are you starting your new ... the right way? 4. Are you ... your d

Read More

Are you maintaining your documentation correctly?

... you ... your ... ... I've said in many eZines, yo

Read More

Successful Documentation Projects – Part 1 of 3 – ‘Understanding’

The creation of user documentation is a big component of any software project. Unfortunately, it’s often undervalued and left to the last minute. But that doesn’t mean it should be without a good management plan.

Read More

Successful Documentation Projects – Part 3 of 3 – ‘Writing’

So you understand your user documentation project and you’ve specced it out. Now you’re ready to write. Here’s some tips to help you on your way. This article isn’t about the actual writing itself; it’s about the things which go along with the writing. (For information on writing online help, see www.divinewrite.com/helpfulhelp.htm.)

Read More

The Top Five Mistakes That Companies Make with Regard to Technical Documentation

I’ve seen it time and again. One of the most common ... that I’ve seen in ... ... an almost ... fault—is the lack of proper ... ... Some would laugh

Read More

Helping Supervisors become Performance Managers

How does your organization prepare supervisors to manage employee performance?Supervisory training and development programs play a critical role in helping supervisors become performance managers. The purpose of this article is to provide five tools that will lead supervisors to become better managers of employee performance.

Read More

Key Role Of Technical Documentation In Mobile App Development

This blog highlights the importance of technical documentation for mobile app development. It also focuses on benefits and purpose of technical documentation in the overall development process.

Read More

Benefits of Creating User Documents In-House

For small companies, creating User Documentation in-house, provides benefits to the company, to (idle) staff, and to the product. This article describes the benefits and some downsides of producing User Documents in-house.

Read More

Software Configuration Management... for the Technical Writer

Many software ... with which I've worked didn't have any type ... in place for tracking and managing their ... Usually two orthree lead ... ... the ... Everyone e

Read More

Cisco CCNP CIT Exam Training: Creating A Network Baseline

Creating a network baseline is an important skill for the CCNP exams, and it's even more important in real-world networks. Learn the basic of creating a baseline from Chris Bryant, CCIE #12933.

Read More

Rules for Good Documentation Practices in Pharmaceuticals

All doucments should be maintained properly as per the standard operating procedure. It should be applied for both printed and electronic documents.

Read More

The Case of the Vanishing Technology

The Case of the ... ... full color web version ... you ... to this ... ... ...

Read More

Got an idea worth working for? A case study.

... an idea worth working for? A case ... 1. Does this problem sound

Read More