用户手册英文模板usermanualtemplate.docx
- 文档编号:8751940
- 上传时间:2023-02-01
- 格式:DOCX
- 页数:8
- 大小:38.90KB
用户手册英文模板usermanualtemplate.docx
《用户手册英文模板usermanualtemplate.docx》由会员分享,可在线阅读,更多相关《用户手册英文模板usermanualtemplate.docx(8页珍藏版)》请在冰豆网上搜索。
用户手册英文模板usermanualtemplate
USER’S
MANUAL
ProjectorSystemName
.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#
GENERALINFORMATION
NOTETOAUTHOR:
highlighted,italicizedtextthroughoutthistemplateisprovidedsolelyasbackgroundinformationtoassistyouincreatingthisdocument.Pleasedeleteallsuchtext,aswellastheinstructionsineachsection,priortosubmittingthisdocument.ONLYYOURPROJECT-SPECIFICINFORMATIONSHOULDAPPEARINTHEFINALVERSIONOFTHISDOCUMENT.
TheUser’sManualprovidestheinformationnecessaryfortheusertoeffectivelyusetheautomatedinformationsystem.
1.0GENERALINFORMATION
SystemOverview
Explainingeneraltermsthesystemandthepurposeforwhichitisintended.Thedescriptionshallinclude:
Majorfunctionsperformedbythesystem
Describethearchitectureofthesysteminnon-technicalterms,.,client/server,Web-based,etc.)
Useraccessmode,.,graphicaluserinterface)
Responsibleorganization
Systemnameortitle
Systemcode
Systemcategory:
Majorapplication:
performsclearlydefinedfunctionsforwhichthereisareadilyidentifiablesecurityconsiderationandneed
Generalsupportsystem:
providesgeneralADPornetworksupportforavarietyofusersandapplications
Operationalstatus:
Operational
Underdevelopment
Undergoingamajormodification
Generaldescription
Systemenvironmentorspecialconditions
ProjectReferences
Providealistofthereferencesthatwereusedinpreparationofthisdocumentinorderofimportancetotheenduser.
AuthorizedUsePermission
Provideawarningregardingunauthorizedusageofthesystemandmakingunauthorizedcopiesofdata,software,reports,anddocuments,ifapplicable.Ifwaiveruseorcopypermissionsneedtobeobtained,describetheprocess.
PointsofContact
Information
Providealistofthepointsoforganizationalcontact(POCs)thatmaybeneededbythedocumentuserforinformationalandtroubleshootingpurposes.Includetypeofcontact,contactname,department,telephonenumber,ande-mailaddress(ifapplicable).Pointsofcontactmayinclude,butarenotlimitedto,helpdeskPOC,development/maintenancePOC,andoperationsPOC.
Coordination
Providealistoforganizationsthatrequirecoordinationbetweentheprojectanditsspecificsupportfunction.,installationcoordination,security,etc.).Includeascheduleforcoordinationactivities.
HelpDesk
Providehelpdeskinformationincludingresponsiblepersonnelphonenumbersforemergencyassistance.
OrganizationoftheManual
ProvidealistofthemajorsectionsoftheUser’sManual,,,etc.)andabriefdescriptionofwhatiscontainedineachsection.
AcronymsandAbbreviations
Providealistoftheacronymsandabbreviationsusedinthisdocumentandthemeaningofeach.
SYSTEMSUMMARY
2.0SYSTEMSUMMARY
Thissectionprovidesageneraloverviewofthesystemwritteninnon-technicalterminology.Thesummaryshouldoutlinetheusesofthesysteminsupportingtheactivitiesoftheuserandstaff.
SystemConfiguration
Brieflydescribeanddepictgraphicallytheequipment,communications,andnetworksusedbythesystem.Includethetypeofcomputerinputandoutputdevices.
DataFlows
Brieflydescribeordepictgraphically,theoverallflowofdatainthesystem.Includeauser-orienteddescriptionofthemethodusedtostoreandmaintaindata.
UserAccessLevels
Describethedifferentusersand/orusergroupsandtherestrictionsplacedonsystemaccessibilityoruseforeach.
ContingenciesandAlternateModesofOperation
Onahighlevel,explainthecontinuityofoperationsintheeventofemergency,disaster,oraccident.Explainwhattheeffectofdegradedperformancewillhaveontheuser.
GETTINGSTARTED
3.0GETTINGSTARTED
Thissectionprovidesageneralwalkthroughofthesystemfrominitiationthroughexit.Thelogicalarrangementoftheinformationshallenablethefunctionalpersonneltounderstandthesequenceandflowofthesystem.Usescreenprintstodepictexamplesoftextundereachheading.
LoggingOn
Describetheproceduresnecessarytoaccessthesystem,includinghowtogetauserIDandlogon.Ifapplicable,identifyjobrequestformsorcontrolstatementsandtheinput,frequency,reason,origin,andmediumforeachtypeofoutput.
SystemMenu
Thissectiondescribesingeneraltermsthesystemmenufirstencounteredbytheuser,aswellasthenavigationpathstofunctionsnotedonthescreen.Eachsystemfunctionshouldbeunderaseparatesectionheader,-[SystemFunctionName]
Provideasystemfunctionnameandidentifierhereforreferenceintheremainderofthesubsection.Describethefunctionandpathwayofthemenuitem.Provideanaverageresponsetimetousethefunction.
ChangingUserIDandPassword
DescribehowtheuserchangesauserID.Describetheactionsausermusttaketochangeapassword.
ExitSystem
Describetheactionsnecessarytoproperlyexitthesystem.
USINGTHESYSTEM(ONLINE)
Thissectionprovidesadetaileddescriptionoftheonlinesystemfrominitiationthroughexit,explainingindetailthecharacteristicsoftherequiredinputandsystem-producedoutput.THISSECTIONISONLYTOBEUSEDFORONLINESYSTEMS.IFYOUAREDEVELOPINGABATCHSYSTEM,USESECTIONANDOMITTHISSECTIONENTIRELY.
4.0USINGtheSYSTEM(ONline)
Thissectionprovidesadetaileddescriptionofsystemfunctions.Eachfunctionshouldbeunderaseparatesectionheader,-,andshouldcorrespondsequentiallytothesystemfunctions(menuitems)listedinsubsections-[SystemFunctionName]
Provideasystemfunctionnameandidentifierhereforreferenceintheremainderofthesubsection.Describethefunctionindetailanddepictgraphically.Includescreencapturesanddescriptivenarrative.
[SystemSub-FunctionName]
Thissubsectionprovidesadetaileddescriptionofsystemsub-functions.Eachsub-functionshouldbeunderaseparatesectionheader,-.Whereapplicable,foreachsub-functionreferencedwithinasectionin,describeindetailanddepictgraphicallythesub-functionname(s)referenced.Includescreencapturesanddescriptivenarrative.
Thenumberingofthefollowingtwosectionswilldependonhowmanysystemfunctionstherearefromthrough.Theyarenumberedhereasandonlyforthesakeofconvenience.Forexample,ifsystemfunctionsrunfromsectionsthrough,thenthefollowingtwosectionswouldbenumberedand.
SpecialInstructionsforErrorCorrection
Describeallrecoveryanderrorcorrectionprocedures,includingerrorconditionsthatmaybegeneratedandcorrectiveactionsthatmayneedtobetaken.
CaveatsandExceptions
Iftherearespecialactionstheusermusttaketoinsurethatdataisproperlysavedorthatsomeotherfunctionexecutesproperly,describethoseactionshere.Includescreencapturesanddescriptivenarratives,ifapplicable.
USINGTHESYSTEM(BATCH)
Thissectionprovidesadetaileddescriptionofthebatchsystemfrominitiationthroughexit,explainingindetailthecharacteristicsoftherequiredinputandsystem-producedoutput.THISSECTIONISONLYTOBEUSEDFORBATCHSYSTEMS.IFYOUAREDEVELOPINGANONLINESYSTEM,USESECTIONANDOMITTHISSECTIONENTIRELY.
5.0USINGtheSYSTEM(batch)
Thissectionprovidesadetaileddescriptionofsystemfunctions.Eachfunctionshouldbeunderaseparatesectionheader,-,andshouldcorrespondsequentiallytothesystemfunctions(menuitems)listedinsubsections-[SystemFunctionName]
Provideasystemfunctionnameandidentifierhereforreferenceintheremainderofthesubsection.Describethefunctionindetailanddepictgraphically.Includescreencapturesanddescriptivenarrative.
[SystemSub-FunctionName]
Thissubsectionprovidesadetaileddescriptionofsystemsub-functions.Eachsub-functionshouldbeunderaseparatesectionheader,-Whereapplicable,foreachsub-functionreferencedwithinasectionin,describeindetailanddepictgraphicallythesub-functionname(s)referenced.Includescreencapturesanddescriptivenarrative.
Thenumberingofthefollowingthreesectionswilldependonhowmanysystemfunctionstherearefromthrough.Theyarenumberedhereas,,andonlyforthesakeofconvenience.Forexample,ifsystemfunctionsrunfromsectionsthrough,thenthefollowingthreesectionswouldbenumbered,and.
SpecialInstructionsforErrorCorrection
Describeallrecoveryanderrorcorrectionprocedures,includingerrorconditionsthatmaybegeneratedandcorrectiveactionst
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 用户手册 英文 模板 usermanualtemplate