IX542 Multimedia Development and

ImplementationJon Hilden

May 21, 2013

Identify your audience Research the product Interview subject matter experts to get needed

information Develop an outline Submit graphics requests Transform technical material into a common

language that can be understood Edit written material Have subject matter experts review the material Print and bind the manual and deliver the final

product

The development process

Critical to the documentation development process

Helps determine the amount of information and the level of detail of the document

Helps determine the style of writing that might best appeal to the reader

Helps determine vocabulary

Identify your audience

What is the nature of the product? How will it be used? Who will use it? How much background information will

the user need about the product? Are there safety issues related to the

product’s installation, maintenance, use, etc.?

Research the product

Gather preliminary information about the product, installation process, maintenance procedures, etc.

Ask for engineering notes or any related documents the SME may have

Ask for their permission to send them copies of the documentation for review

Interview subject matter experts

Resist starting documentation development without an outline

Develop an outline based on SME input and product research

Have a SME, an editor, project manager, etc. review the outline before starting documentation development

Develop the documentation based on the outline

Develop an outline

Do this as soon as possible! Graphics take time to create and will most likely need to be revised

Submit graphics to SME, an editor, project manager, etc. for review

Submit graphics requests

Remember who your audience is Avoid adding superfluous information Write in active voice as much as

possible Provide a level of detail appropriate

for the subject matter Less is usually better!

Write in a clear, concise, understandable language

Passive voice: “The installation crew will use company-supplied tools to install the supercomputer.”

Active voice: “Use company-supplied tools to install the supercomputer.”

Active voice vs. passive voice

Edit the document before sending it to technical review

Don’t rely on others to do your work for you

Pretend that the copy you are editing will go to print after the edit is complete

Edit the written material

Send a preliminary draft of the material through an extensive review process

Review text and graphics Involve editors, SMEs, project managers,

and at least one person who is not at all familiar with the product

Contact your reviewers to get a progress update

Be sure to address all review comments Be sure to thank those who took the time

to review the documentation

Technically review the material

Is there a procedure in place for printing and binding the finished product?

Establish contact with the printer well ahead of time – don’t wait until the last minute

Carefully inspect the print proof for correct page count, clear graphics, proper layout, secure binding, etc.

Print and bind the material

Verify that the finished product is in distribution or logistics and is available to the end user

Deliver the final product

Identify your audience Research the product Interview subject matter experts to get needed

information Develop an outline Submit graphics requests Transform technical material into a common

language that can be understood Edit written material Have subject matter experts review the material Print and bind the manual and deliver the final

product

Summary

Thanks for watching!

Images courtesy of http://images.nrel.gov/

Credits