技术文档写作ppt课件.ppt

《技术文档写作ppt课件.ppt》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、TechnicalWritingKEYSTOWRITINGSUCCESSFULTECHNICALPROSEPurposeAudienceStyleAccuracyCompletenessAudienceWhoareyourreaders?Whatistheirleveloftechnicalexpertiseandbackground?Whataretheirneeds?Howwillyousuccessfullysatisfythoseneeds?Audience:knowledge&backgroundHighlyTechnical

2、Semi-TechnicalNon-TechnicalNote:aimatlowestlevelofknowledgeamongyourreaders.DevelopingAudienceAwarenessWriteasifyouareprovidinganswerstoembeddedquestionsImaginequestionsthereaderwillnaturallyaskaboutthesystemandanswerthemAnticipatethereader'sexpectationsandfulfillthemWri

3、tingStyleWriteforyourreadersWritetoinform,notimpressLessismoreBasicPrinciplesOfWritingEffectiveTechnicalProseClarityConcisenessReadabilityCoherenceAccuracy&CompletenessAchievingClarity1.Organizeyourmaterialslogically:Answerembeddedquestionsinalogicalsequence.Proceedfromt

4、hesimpletothecomplex&fromgeneralconceptstodetailedinformation.Placehighlydetailedandsecondarymaterialsinappendices.2.Useshort,simplesentences.3.Usetheactivevoice.AchievingClarity4.Usepunctuationaccurately:avoidusingdashes,slashes,parenthesis,andotherambiguouspunctuationm

5、arks.5.Keeprelatedwordstogether:placemodifiersclosetothewordstheymodify.AchievingClarity6.Avoidvaguereferents,suchas“it,”“this,”and“that.”7.Replacecomplexwordswithsimplewords:"later"for"subsequently,""use"for"utilize,"etc.8.Clearlydefinetechnicalterminology.9.Summarizeco

6、mplexprocedures&ideasinsimplelists,diagrams,charts,tables,&othervisuals.Conciseness:UsetheActiveVoiceNoticethatthepassivevoicesalways:Usesthewordyandweakverb“tobe”formsinsteadofstrongdescriptiveverbs.Usesthepasttenseverbforminsteadoftheactivestrongpresenttenseform.Alters

7、thenormalsyntaxorderof“Subject-verb-object”sothatthe“Subject”-“isactedupon”-“bytheObject.”ExampleofpassivevoicecorrectedtomoreconciseactivevoicePassive:Jimisintheprocessofbeingkickedbyjohn.Jimisbeingkickedbyjohn.Jimiskickedbyjohn.Active:JohnkicksJim.Exampleofpassivevoice

8、correctedtomoreconciseactivevoicePassive:Thereturnkeyshouldbepressedbytheuser.Thereturnkeyshouldbepress