Understanding the Problem: Know What the Customer Wants

by Dave Jordan

Posted by: on Jul 21, 2016 in Engineering Documentation | No Comments

Nearly everyone has been in a situation where they they thought they knew exactly what the customer wanted and delivered the “perfect” product only to find that they you were just a little off of the target. If only a few more questions had been asked to gain just a bit more insight into the customer’s needs, then a difficult situation could have been avoided.

Read More

Casting the Right People

by Dave Jordan

Posted by: on Jul 19, 2016 in Managing Documentation Projects | No Comments

The key to hiring the right people for a documentation project is to thoroughly understand the task at hand before asking your HR department to hire. Since documentation projects can require various types of backgrounds, differing levels of experience, and knowledge of different authoring tools, it does not suffice to simply hire a “typical” technical writer.

Read More

Maintaining Milestones & Schedule For Technical Documentation

by Dave Jordan

This newsletter focuses on the importance of maintaining the documentation milestones and schedules for developers of hardware and software systems or products. Lets first briefly discuss a few basic principles for establishing documentation milestones with respect to the system’s development.

Read More

Thoughtful Management of the Technical Documentation Tasks

by Dave Jordan

Posted by: on Jun 11, 2016 in Managing Documentation Projects | No Comments

Every project leader knows that most projects are wrought with unexpected twists and turns. Unexpected “fires” that often catch the most experienced manager unprepared and can keep the most ambitious manager from accomplishing his daily planned tasks. Since many of our reader’s projects have grouped the technical documentation and development tasks under the same manager, we are offering a few ideas to these overworked managers that may help ease the burden.

Read More

Using a Technical Documentation Consultant

by Dave Jordan

Posted by: on Jun 11, 2016 in Managing Documentation Projects | No Comments

Instead of sending your technical documentation staff to school, why not bring the instructor to them? Working with a documentation consultant that is willing to share his experience and expertise with your project team will considerably upgrade the talent and productivity of your documentation team members.

Read More

The Technical Writers Checklist

by Dave Jordan

Posted by: on May 11, 2016 in Technical Writing | No Comments

If you’ve read the previous newsletters, you now know the following: We thoroughly understand the task at hand.  We’ve hired the right people.  We’ve identified a Documentation Consultant to help us over the rough spots.  And we’ve established our budgeting and schedule.  NOW LET’S WRITE SOME DOCUMENTS!

Read More