Guide to Creating a Product Manual

Include the basics

Common items to include in a product manual include an illustration of the product with the names of all the parts identified, a list of parts, assembly instructions, troubleshooting tips, frequently asked questions, a glossary and customer service contact information. Mapping out the information with a table of contents and an index makes easier for consumers to find the information they need.

I recommend: Download a worksheet that shows how to organize information in a product manual.

Give it some design

Keep the design of your manual simple. Aim for lots of white space rather than loads of text. Most experts suggest using headlines, subheads and bulleted lists to present information in an easy-to-read format.

I recommend: Download a Microsoft Word template for product booklets or visit your local FedExKinko's to take advantage of their Document Creation Services, which can help you design your product manual.

Write in plain English

Adopt a conversational tone in your manual and avoid technical jargon. Give your manual to several friends or neighbors who aren't familiar with your product and ask them to point out any instructions that don't make sense.

I recommend: Invest in StyleWriter software, which works in conjunction with your word processing software to analyze the text of your product manual and transform it from incomprehensible techno speak into easy-reading English.

Reduce liability risks

You can limit your liability risk by hiring a professional technical writer who can write clean concise instructions that leave no room for error. Professionals who have experience producing product manuals are also familiar with any compliance requirements.

I recommend: Consult WritingAssist.com, which boasts a national database of more than 25,000 technical writers who can work on-site or remotely. Request a quote from MicroController Pros, which provides technical writing services on a contract or freelance basis.

Provide translations

Consider all the possible territories where your product will be sold and the languages spoken in those areas. Translate your product manual into those languages to provide support to your entire customer base.

I recommend: ALS International and Corporate Translation Services offer technical writing in hundreds of languages or you can send your written text and have it translated directly.

Produce your manual

Printing is no longer the only option for producing a product manual. Print-on-demand, downloadable PDF files and CD-ROMs can also be used.

I recommend: Have your product manual printed at PIP or FedExKinkos, which lets you place your order online and also offers a number of binding and finishing options. If your product is software based or marketed to the high-tech industry, consider offering the manual to users in CD format. Print on-demand offers the ability to edit your product manual and create new versions of the manual, while allowing you to print only the quantities you need at the time.