技术文档.docx

技术文档.docx

《技术文档.docx》由会员分享，可在线阅读，更多相关《技术文档.docx（23页珍藏版）》请在冰豆网上搜索。

技术文档

TemplateforIDAProject（ProjectId）

Templateforspecificdevelopment（ContractId）

TechnicalDesignDocument

Issue1

TABLEOFCONTENTS

0Preface1

0.1Purposeofthisdocument1

0.2Useofthisdocument1

0.3Overview2

0.4BasisofthisDocument2

0.5AReferenceArchitecturefortheIDAProgramme3

0.6SpecificDesignConsiderations3

1Introduction5

1.1Purpose5

1.2Scope5

1.3Definitions,AcronymsandAbbreviations5

1.4References6

1.5Overview6

2SystemOverview7

2.1SystemCharacteristics7

2.2SystemArchitecture7

2.3InfrastructureServices9

3SystemContext10

4SystemDesign11

4.1DesignMethodandStandards11

4.2DocumentationStandards12

4.3Namingconventions13

4.4ProgrammingStandards13

4.5Softwaredevelopmenttools13

4.6OutstandingIssues14

4.7DecompositionDescription14

5ComponentDescription15

5.1ComponentIdentifier16

6SoftwareRequirementsTraceabilityMatrix19

DocumentControl20

DocumentSignoff20

DocumentChangeRecord20

0Preface

0.1Purposeofthisdocument

#1ThisdocumentisagenericTechnicalDesignDocumentdocumentforusebyIDAProjects.Itprovidesguidanceandtemplatematerialwhichisintendedtoassisttherelevantmanagementortechnicalstaff,whetherclientorsupplier,inproducingaprojectspecificTechnicalDesignDocumentdocument.ItisalsousefulbackgroundreadingforanyoneinvolvedindevelopingormonitoringtheIDAManagementSystem（IDAMS）.

0.2Useofthisdocument

#2ThisPrefaceisaddressedtotheusersofthisgenericdocumentandisnotmeanttoberetainedinanyprojectspecificTechnicalDesignDocumentdocumentsbasedonit.

#3Theremainingsections（numbered1,2,3,…）constituteatemplatethatshouldbeusedtoconstructtheproject-specificTechnicalDesignDocumentdocument.

▪Textinnormalcaseisinthemostpart“boilerplate”thatcanberetained,amendedordeletedinthedocument.

▪Textinitalicsprovidesinstructionsonhowtocompleteasectionandshouldberemovedoncethesectioniswritten.

#4Thetemplateshouldbeusedpragmatically,thatis-whereasectionisnotrelevantitshouldbeomitted.Conversely,thematerialcontainedinthisdocumentisnotnecessarilyexhaustive;ifthereisasubjectthatisrelevanttotheIDAProject,butisnotincludedinthisdocument,itshouldstillbeincluded.

#5ThisdocumenthasbeenpreparedusingMS Word 97.ThefollowingvariablesarecurrentlyrecordedasFile“Properties”underMS Word.Theymaybemodifiedbythatmeansoroverwrittendirectlyateachoccurrenceinthedocument,atthediscretionoftheuser.

a.“Summary”Properties

Title

Typeofdocument（i.e.TechnicalDesignDocument）

Author

Author（s）ofdocument

Keywords

Documentreference（i.e.IDA-MS-TD）

b.“Custom”Properties

ProjId

ShortmnemonicofIDAProject（set,inthisdocument,to“ProjectId”）

Project

FullnameofIDAProject（set,inthisdocument,to“TemplateforIDAProject”）

ContrId

Shortidentifierofcontract（set,inthisdocument,to“ContractId”）

Contract

Fullnameofcontract（set,inthisdocument,to“Templateforspecificdevelopment”）

Version

Issuenumber（currentlyIssue1）

Date

Dateofdocument（currently17January2001）

0.3Overview

#6Thisprefaceisforinformationonly.

#7Thisprefacewillthereforenotberetainedintheprojectspecificdocument.

#8Theremainingsections（numbered1,2,3,…）constituteatemplatethatshouldbeusedtoconstructtheproject-specificdocument.

▪Textinnormalcaseisinthemostpart“boilerplate”thatcanberetained,amendedordeletedinthedocument.

▪Textinitalicsprovidesinstructionsonhowtocompleteasectionandshouldberemovedoncethesectioniswritten.

▪Textinblue italicsincludesdiscussionandspecificrecommendationsontheapproachtoTechnicalDesignintheIDAcontext.

#9Thetemplateshouldbeusedpragmatically,thatis-whereasectionisnotrelevantitshouldbeomitted.Conversely,thematerialcontainedinthisdocumentisnotnecessarilyexhaustive;ifthereisasubjectthatisrelevanttotheproject,butisnotincludedinthisdocument,itshouldstillbeincluded.

0.4BasisofthisDocument

#10ThisfollowingintroductorysectionssetoutanapproachtodesigningsystemsthatmaybedevelopedunderIDA.ItattemptstosetstandardsandcreateaconsistentapproachtothedesignanddevelopmentofsystemsacrosstheIDAProgramme.ItwillenabletheProgrammetobenefitfrom‘economiesofscale’andaconsistencyintheapproachtobuildinganddeployingsystems.Importantissuesthatneedtobeconsideredincludethearchitectureofsystems,linkstolegacysystems,contemporaryapproachestodesign（ObjectOrientedDesign）,aimsforcodere-useandtheneedtodevelopsystemsthatwillworkonanoperationalbasisovermanyyearsandtheassociateddesiretomakesuchsystemseasilysupportableandaffordable.

#11AkeypointwillbetobuildontheworkalreadycarriedoutinIDAanditspredecessorprogrammes,wherealargenumberofspecific‘technical’developmentswereundertakenlookingat,forexample,standardsfordataexchange,suchasGESMES,andtheintroductionofcontemporarytechnologiesandinfrastructures.

#12TheconceptofaReferenceArchitectureisalsointroducedaspartoftheprocessofcreatinganinteroperableenvironmentwhichfacilitatestheexchangeofinformationbetweenadministrationsthroughsettingoutanumberofstandardbuildingblocksaroundwhichsolutionscanbeassembled.Thesebuildingblocksor‘componentsreflecttheemergingtechnologiesthatshouldformthetechnicalbasisoftheIDAdevelopments.TheseincludetheCommonObjectRequestBrokerArchitecture（CORBA）,RemoteMethodInvocation（RMI）andEnterpriseJavaBeans（EJB）technologiesthathighlightcodere-use,scalabilityandthecreationofinteroperablearchitecturesaroundlegacyenvironments.

0.5AReferenceArchitecturefortheIDAProgramme

#13OneofthegreatestdifficultiesfacingtheIDAProgrammeishowtocreateaninteroperablearchitectureacrossEuropeanadministrationswhilstallowingindividualprojectstomanagetheirownIDAdevelopmentswithsub-delegatedauthority.Undersub-delegation,itwouldbepossibleforsectorsseekingtobeselectedtobuildelementsoftheoverallIDAProgrammetoproposetheirownsolutions,orthesolutionsproposedbytheirselectedsuppliers,therebyexacerbatingtheexistingheterogeneousenvironment,whichisindirectconflictwiththeaimofcreatinganinteroperablearchitecture.

#14InpracticetheIDAProgrammeshouldseektocreatewhatcanbereferredtoasaReferenceArchitectureforsystems–ineffectaseriesofestablishedbuildingblocksonwhichavarietyofsystemsshouldbeassembled.TheReferenceArchitectureshouldthenbecomepartoftheIDAArchitectureGuidelines.

#15TheReferenceArchitecturewouldtakeann-tier,client-servermodelasitsbasis,andstatethatthepersistencelayerwouldbeimplementedthroughanumberofstandardAPIcallstoaparticulardatabasesystem.ThisuseofaReferenceArchitecturewouldprovidesomeguidelinestoorganisationstaskedwithdevelopingindividualelementsoftheIDAProgrammeandwould,intime,movesolutionstowardsacommonhomogeneousstandard–withallofitsassociatedbenefits.

#16Recommendationscouldbemadeonthereportingtoolthatshouldbeusedinsystemsifonewererequired,theWebBrowsercouldbestandardised,ascouldanysecurityfeaturesthatneededtobebuiltintothesystem.TheReferenceArchitecturewouldfacilitatere-usethroughouttheIDA Programmeasindividualprojectscouldbearrangedtosupportthedevelopmentoflibrariesofcomponentsthatcanbere-used.ThiswillbeoneofthemajorpotentialbenefitsthatcouldarisefromthecreationofaReferenceArchitecture.

0.6SpecificDesignConsiderations

#17PerhapsoneofthemostcrucialaspectsofthisisthelevelofconcurrencythatwillbepresentintypicalIDAprojects.ThusfarprojectsfallingwithintheIDAProgrammehavetendedgenerallynottoinvolvelargescale,transaction-basedcomputing.ThetransmissionofinformationfromanMSAtotheEuropeanUnion,containinginformationon–forexample–employmentstatistics,hasfocusedontheneedtocreatecommonapproachestotheformattingofthedataandtohandlinglanguageissues.Itispossiblethatfutureprojectswillinvolvemorefrequentupdatesfromparticipatingadministrations.InthiscaseattentionintheReferenceArchitecturetotheloadingoncomputersystemswillbenecessary.

#18OODwillalsobecomeincreasinglyusedintheIDAProgrammeasdevelopmentsseektocreatesystemsthataremoremaintainableovertheirdeploymentlifetime.TheknockoneffectofthiswillbeanincreasingemphasisontheuseofCommercialOffTheShelf（COTS）packagesinthesoftwarearchitectureinareassuchasthedatabase,middleware,reportingtoolsandintheGraphicalUserInterface.

#19IDAprojectsmaywellshiftfromatraditionalwaterfalldevelopmentapproachtothedesignanddevelopmentofsolutionstowardsRapidApplicationsDevelopment（RAD）.Thiswillhavefundamentalimplicationsforthedesignprocess.IDAprojectleaderswillneedtoconsiderthecreationofJointApplicationsDevelopment（JAD）teamsthataremadeupfromsoftwaredevelopersandpeopledrawnfromtheuseradministrationswithbusinessexperienceoftheapplicationareainquestion.Stageddevelopment,throughso-called‘timeboxes’,offersmanyattractionstodesignersanddevelopersofcontemporarysystems.IDAProjectLeadersshouldgiveseriousconsiderationtotheadoptionofthisapproachasawayofensuringsystemsaredeliveredintooperationthatmeetup-to-dateuserrequiremen