用户手册英文模板 user manual template.docx

用户手册英文模板 user manual template.docx

《用户手册英文模板 user manual template.docx》由会员分享，可在线阅读，更多相关《用户手册英文模板 user manual template.docx（8页珍藏版）》请在冰豆网上搜索。

用户手册英文模板usermanualtemplate

USER’S

MANUAL

ProjectorSystemName

U.S.DepartmentofHousingandUrbanDevelopment

Month,Year

RevisionSheet

ReleaseNo.

Date

RevisionDescription

Rev.0

5/30/00

User’sManualTemplateandChecklist

Rev.1

4/10/02

ConversiontoWORD2000format

User’sManual

AuthorizationMemorandum

IhavecarefullyassessedtheUser’sManualforthe（SystemName）.ThisdocumenthasbeencompletedinaccordancewiththerequirementsoftheHUDSystemDevelopmentMethodology.

MANAGEMENTCERTIFICATION-Pleasechecktheappropriatestatement.

______Thedocumentisaccepted.

______Thedocumentisacceptedpendingthechangesnoted.

______Thedocumentisnotaccepted.

Wefullyacceptthechangesasneededimprovementsandauthorizeinitiationofworktoproceed.Basedonourauthorityandjudgment,thecontinuedoperationofthissystemisauthorized.

____________________________________________________

NAMEDATE

ProjectLeader

____________________________________________________

NAMEDATE

OperationsDivisionDirector

____________________________________________________

NAMEDATE

ProgramArea/SponsorRepresentative

____________________________________________________

NAMEDATE

ProgramArea/SponsorDirector

USER'SMANUAL

TABLEOFCONTENTS

Page#

1.0GENERALINFORMATION

NOTETOAUTHOR:

highlighted,italicizedtextthroughoutthistemplateisprovidedsolelyasbackgroundinformationtoassistyouincreatingthisdocument.Pleasedeleteallsuchtext,aswellastheinstructionsineachsection,priortosubmittingthisdocument.ONLYYOURPROJECT-SPECIFICINFORMATIONSHOULDAPPEARINTHEFINALVERSIONOFTHISDOCUMENT.

TheUser’sManualprovidestheinformationnecessaryfortheusertoeffectivelyusetheautomatedinformationsystem.

1.0GENERALINFORMATION

1.1SystemOverview

Explainingeneraltermsthesystemandthepurposeforwhichitisintended.Thedescriptionshallinclude:

∙Majorfunctionsperformedbythesystem

∙Describethearchitectureofthesysteminnon-technicalterms,（e.g.,client/server,Web-based,etc.）

∙Useraccessmode,（e.g.,graphicaluserinterface）

∙Responsibleorganization

∙Systemnameortitle

∙Systemcode

∙Systemcategory:

-Majorapplication:

performsclearlydefinedfunctionsforwhichthereisareadilyidentifiablesecurityconsiderationandneed

-Generalsupportsystem:

providesgeneralADPornetworksupportforavarietyofusersandapplications

∙Operationalstatus:

-Operational

-Underdevelopment

-Undergoingamajormodification

∙Generaldescription

∙Systemenvironmentorspecialconditions

1.2ProjectReferences

Providealistofthereferencesthatwereusedinpreparationofthisdocumentinorderofimportancetotheenduser.

1.3AuthorizedUsePermission

Provideawarningregardingunauthorizedusageofthesystemandmakingunauthorizedcopiesofdata,software,reports,anddocuments,ifapplicable.Ifwaiveruseorcopypermissionsneedtobeobtained,describetheprocess.

1.4PointsofContact

1.4.1Information

Providealistofthepointsoforganizationalcontact（POCs）thatmaybeneededbythedocumentuserforinformationalandtroubleshootingpurposes.Includetypeofcontact,contactname,department,telephonenumber,ande-mailaddress（ifapplicable）.Pointsofcontactmayinclude,butarenotlimitedto,helpdeskPOC,development/maintenancePOC,andoperationsPOC.

1.4.2Coordination

Providealistoforganizationsthatrequirecoordinationbetweentheprojectanditsspecificsupportfunction（e.g.,installationcoordination,security,etc.）.Includeascheduleforcoordinationactivities.

1.4.3HelpDesk

Providehelpdeskinformationincludingresponsiblepersonnelphonenumbersforemergencyassistance.

1.5OrganizationoftheManual

ProvidealistofthemajorsectionsoftheUser’sManual（1.0,2.0,3.0,etc.）andabriefdescriptionofwhatiscontainedineachsection.

1.6AcronymsandAbbreviations

Providealistoftheacronymsandabbreviationsusedinthisdocumentandthemeaningofeach.

2.0SYSTEMSUMMARY

2.0SYSTEMSUMMARY

Thissectionprovidesageneraloverviewofthesystemwritteninnon-technicalterminology.Thesummaryshouldoutlinetheusesofthesysteminsupportingtheactivitiesoftheuserandstaff.

2.1SystemConfiguration

Brieflydescribeanddepictgraphicallytheequipment,communications,andnetworksusedbythesystem.Includethetypeofcomputerinputandoutputdevices.

2.2DataFlows

Brieflydescribeordepictgraphically,theoverallflowofdatainthesystem.Includeauser-orienteddescriptionofthemethodusedtostoreandmaintaindata.

2.3UserAccessLevels

Describethedifferentusersand/orusergroupsandtherestrictionsplacedonsystemaccessibilityoruseforeach.

2.4ContingenciesandAlternateModesofOperation

Onahighlevel,explainthecontinuityofoperationsintheeventofemergency,disaster,oraccident.Explainwhattheeffectofdegradedperformancewillhaveontheuser.

3.0GETTINGSTARTED

3.0GETTINGSTARTED

Thissectionprovidesageneralwalkthroughofthesystemfrominitiationthroughexit.Thelogicalarrangementoftheinformationshallenablethefunctionalpersonneltounderstandthesequenceandflowofthesystem.Usescreenprintstodepictexamplesoftextundereachheading.

3.1LoggingOn

Describetheproceduresnecessarytoaccessthesystem,includinghowtogetauserIDandlogon.Ifapplicable,identifyjobrequestformsorcontrolstatementsandtheinput,frequency,reason,origin,andmediumforeachtypeofoutput.

3.2SystemMenu

Thissectiondescribesingeneraltermsthesystemmenufirstencounteredbytheuser,aswellasthenavigationpathstofunctionsnotedonthescreen.Eachsystemfunctionshouldbeunderaseparatesectionheader,3.2.1-3.2.x.

3.2.x[SystemFunctionName]

Provideasystemfunctionnameandidentifierhereforreferenceintheremainderofthesubsection.Describethefunctionandpathwayofthemenuitem.Provideanaverageresponsetimetousethefunction.

3.3ChangingUserIDandPassword

DescribehowtheuserchangesauserID.Describetheactionsausermusttaketochangeapassword.

3.4ExitSystem

Describetheactionsnecessarytoproperlyexitthesystem.

4.0USINGTHESYSTEM（ONLINE）

Thissectionprovidesadetaileddescriptionoftheonlinesystemfrominitiationthroughexit,explainingindetailthecharacteristicsoftherequiredinputandsystem-producedoutput.THISSECTIONISONLYTOBEUSEDFORONLINESYSTEMS.IFYOUAREDEVELOPINGABATCHSYSTEM,USESECTION5.0ANDOMITTHISSECTIONENTIRELY.

4.0USINGtheSYSTEM（ONline）

Thissectionprovidesadetaileddescriptionofsystemfunctions.Eachfunctionshouldbeunderaseparatesectionheader,4.1-4.x,andshouldcorrespondsequentiallytothesystemfunctions（menuitems）listedinsubsections3.2.1-3.2.x.

4.x[SystemFunctionName]

Provideasystemfunctionnameandidentifierhereforreferenceintheremainderofthesubsection.Describethefunctionindetailanddepictgraphically.Includescreencapturesanddescriptivenarrative.

4.x.y[SystemSub-FunctionName]

Thissubsectionprovidesadetaileddescriptionofsystemsub-functions.Eachsub-functionshouldbeunderaseparatesectionheader,4.1.1.-4.x.y.Whereapplicable,foreachsub-functionreferencedwithinasectionin4.x,describeindetailanddepictgraphicallythesub-functionname（s）referenced.Includescreencapturesanddescriptivenarrative.

Thenumberingofthefollowingtwosectionswilldependonhowmanysystemfunctionstherearefrom4.1through4.x.Theyarenumberedhereas4.2and4.3onlyforthesakeofconvenience.Forexample,ifsystemfunctionsrunfromsections4.1through4.17,thenthefollowingtwosectionswouldbenumbered4.18and4.19.

4.2SpecialInstructionsforErrorCorrection

Describeallrecoveryanderrorcorrectionprocedures,includingerrorconditionsthatmaybegeneratedandcorrectiveactionsthatmayneedtobetaken.

4.3CaveatsandExceptions

Iftherearespecialactionstheusermusttaketoinsurethatdataisproperlysavedorthatsomeotherfunctionexecutesproperly,describethoseactionshere.Includescreencapturesanddescriptivenarratives,ifapplicable.

5.0USINGTHESYSTEM（BATCH）

Thissectionprovidesadetaileddescriptionofthebatchsystemfrominitiationthroughexit,explainingindetailthecharacteristicsoftherequiredinputandsystem-producedoutput.THISSECTIONISONLYTOBEUSEDFORBATCHSYSTEMS.IFYOUAREDEVELOPINGANONLINESYSTEM,USESECTION4.0ANDOMITTHISSECTIONENTIRELY.

5.0USINGtheSYSTEM（batch）

Thissectionprovidesadetaileddescriptionofsystemfunctions.Eachfunctionshouldbeunderaseparatesectionheader,5.1-5.x,andshouldcorrespondsequentiallytothesystemfunctions（menuitems）listedinsubsections3.2.1-3.2.x.

5.x[SystemFunctionName]

Provideasystemfunctionnameandidentifierhereforreferenceintheremainderofthesubsection.Describethefunctionindetailanddepictgraphically.Includescreencapturesanddescriptivenarrative.

5.x.y[SystemSub-FunctionName]

Thissubsectionprovidesadetaileddescriptionofsystemsub-functions.Eachsub-functionshouldbeunderaseparatesectionheader,5.1.1-5.x.y.Whereapplicable,foreachsub-functionreferencedwithinasectionin5.x,describeindetailanddepictgraphicallythesub-functionname（s）referenced.Includescreencapturesanddescriptivenarrative.

Thenumberingofthefollowingthreesectionswilldependonhowmanysystemfunctionstherearefrom5.1through5.x.Theyarenumberedhereas5.2,5.3,and5.4onlyforthesakeofconvenience.Forexample,ifsystemfunctionsrunfromsecti