Chapter 2Chapter 2Preparing an Effective Preparing an Effective Technical DocumentTechnical Document

Complete the Key Tasks Complete the Key Tasks

Deliver the essential informationDeliver the essential information Make a persuasive caseMake a persuasive case Weigh the ethical issuesWeigh the ethical issues Work in teamsWork in teams

Rely on Creative and Critical Rely on Creative and Critical ThinkingThinking

Creative ThinkingCreative Thinking– Explore new ideasExplore new ideas– Build on informationBuild on information– Devise better ways Devise better ways

of doing thingsof doing things

Critical ThinkingCritical Thinking– Test the strength of Test the strength of

ideasideas– Test the worth of Test the worth of

informationinformation– Do not accept an Do not accept an

idea at face valueidea at face value

The Writing Process for The Writing Process for Technical DocumentsTechnical Documents

Gather and evaluate ideas and Gather and evaluate ideas and informationinformation

Plan the documentPlan the document Draft the documentDraft the document Revise the documentRevise the document

Recursive ProcessRecursive Process

The Final StepThe Final Step

ProofreadingProofreading– Basic errors annoy the user and make Basic errors annoy the user and make

the writer look badthe writer look bad– Avoid basic errors even in drafts being Avoid basic errors even in drafts being

reviewed by colleaguesreviewed by colleagues