同行评审过程描述.docx
《同行评审过程描述.docx》由会员分享,可在线阅读,更多相关《同行评审过程描述.docx(36页珍藏版)》请在冰豆网上搜索。
同行评审过程描述
同行评审过程描述
1.Overview(概述)
Inapeerreview,co-workersofapersonwhocreatedasoftwareworkproductexaminethatproducttoidentifydefectsandcorrectshortcomings.Areview:
在同行评审中,由软件工作产品创建者的同行们检查该工作产品,识别产品的缺陷,改进产品的不足。
评审:
•verifieswhethertheworkproductcorrectlysatisfiesthe
specificationsfoundinanypredecessorworkproduct,suchasrequirementsordesigndocuments
•检验工作产品是否正确的满足了以往的工作产品中建立的规范,如需求或设计文档
•identifiesanydeviationfromstandards,includingissuesthatmayaffectmaintainabilityofthesoftware
•识别工作产品相对于标准的偏差,包括可能影响软件可维护性的问题
•suggestsimprovementopportunitiestotheauthor
•向创建者提出改进建议
•promotestheexchangeoftechniquesandeducationoftheparticipants.
•促进参与者之间的技术交流和学习
Allinterimandfinaldevelopmentworkproductsarecandidatesforreview,including:
所有中间和最终的开发工作产品都可以进行评审,包括:
•requirementsspecifications
•需求规格说明书
•userinterfacespecificationsanddesigns
•用户界面规范及设计
•architecture,high-leveldesign,anddetaileddesignsandmodels
•架构,概要设计,详细设计及模型
•sourcecode
•源代码
•testplans,designs,cases,andprocedures
•测试计划,设计,用例及步骤
•softwaredevelopmentplans,includingprojectmanagementplan,configurationmanagementplan,andqualityassuranceplan
•软件开发计划,包括项目管理计划,配置管理计划和质量保证计划
Thisdocumentdefinesanoverallpeerreviewprocess.Itincludesproceduresforconductinginspectionsandtwotypesofinformalpeerreview,awalkthroughandapassaround,aswellasguidanceforselectingtheappropriateapproachforeachreview.
该文档定义了一个全面的同行评审过程。
包括了执行评审的步骤和两种非正式的同行评审,走查和轮查,以及对每个评审选择适当方法的指南。
2.WorkAids(工作辅助项)
Thefollowingpeerreviewworkaidsareavailablefrom:
<场所>中,需要有如下的同行评审工作辅助项:
•InspectionSummaryReport
•评审总结报告
•IssueLog
•问题日志
•TypoList
•微错清单
•InspectionModerator'sChecklist
•评审负责人的检查表
•InspectionLessonsLearnedQuestionnaire
•评审经验教训问卷
•defectchecklistsforseveraltypesofsoftwareworkproducts
•各种软件工作产品的缺陷检查表
3.RiskAssessmentGuidance(风险评估指南)
Tojudgewhichsoftwarecomponents(orportionsofcomponents)toreviewandwhattypeofreviewmethodtouse,considerthefollowingriskcriteria:
在判断哪些软件组件(或组件的部分)需要评审及使用哪种评审方法的时候,需要考虑如下的风险条件:
•componentsthatusenewtechnology,techniques,ortools
•使用了新技术,方法,工具的组件
•keyarchitecturalcomponents
•关键的架构性的组件
•complexlogicoralgorithmsthataredifficulttounderstandbutmustbeaccurateandoptimized
•难以理解,却又必须准确和优化的复杂逻辑或算法
•mission-,security-,orsafety-criticalcomponentswithdangerousfailuremodes
•具有危险失败模式的组件,而且是任务、可靠性、安全性关键的
•componentshavingmanyexceptionconditionsorfailuremodes
•具有多个异常条件或失败模式的组件
•exceptionhandlingcodethatcannoteasilybetested
•不易测试的异常处理代码
•componentsthatareintendedtobereused
•打算复用的组件
•
components
componentsthatwillserveasmodelsortemplatesforother
•将作为其他组件的模型或模板的组件
•componentsthataffectmultipleportionsoftheproduct
•影响产品多个部分的组件
•complexuserinterfaces
•复杂的用户界面
•componentscreatedbylessexperienceddevelopers
•由缺乏经验的开发者创建的组件
•codemoduleshavinghighcyclomaticcomplexity
•具有高度圈复杂性的代码模块
•moduleshavingahistoryofmanydefectsorchanges
•以往具有很多缺陷或变更的模块
Workproductsthatfitinoneormoreofthesecategoriesare
consideredhighrisk.Aproductisconsideredlowriskifanundetectederrorwill
notsignificantaffecttheproject'sabilitytomeetitsschedule,quality,cost,
andfeatureobjectives.Useinspectionsforhigh-riskworkproducts,orthehigh-riskportionsoflargeproducts,andformajorworkproductsthatareabouttobebaselined.Lessformalreviewsareacceptableforotherworkproducts
符合这些条件中一种或几种的工作产品被认为是高风险的。
如果未发现的
缺陷对项目达成进度,质量,成本及特征目标的能力没有重大影响,则该工作产品被认为是
低风险的。
评审只用于高风险的工作产品或大产品的高风险部分或将要被基线化的主要工作产品。
对其他的工作产品可以进行不太正式的评审。
4.Participants(参与者)
Table1suggestsprojectroleswhomightreviewdifferentwork
products.Notalloftheseperspectivesneedtoberepresented.Ingeneral,awork
productshouldbereviewedby:
表1列出了评审不同工作产品的项目角色。
不是所有这些角度都必须表现
出来。
通常,一项工作产品的评审需要有:
•theauthorofanypredecessordocumentorspecification
•以往的文档或规范的创建者
•someonewhomustbasetheirsubsequentworkontheworkproduct
•以该工作产品为基础进行后续工作的人。
•peersoftheauthor
•创建者的同行们
•anyoneresponsibleforacomponenttowhichtheworkproduct
interfaces
•使用该工作产品接口的组件的负责人
Attendancebyanyonewithsupervisoryauthorityovertheauthorisbyinvitationoftheauthoronly.
对工作产品创建者具有监督权力的人只能在创建者的邀请下参加评审。
Table1.ReviewParticipantsforDifferentTypesofWorkProducts.
表1.各类工作产品的参评人
WorkProductType工作产品类
型
WorkProductType工作产品类型
ArchitectureorHigh-Level
Design架构或概要设计
architect,requirementsanalyst,designer,projectmanager,integrationtestengineer架构师,需求分析师,设计师,项目经
理,集成测试工程师
DetailDesign详细设计
designer,architect,programmer,integrationtestengineer设
计师,架构师,程序员,集成测试工程师
ProcessDocumentation过程文
档
processimprovementgroupleader,processimprovementworkinggroupmembers,management-levelprocessowner,practitionerrepresentativeswhowillusetheprocess过程改进组负责人,过
程改进工作组成员,管理级的过程拥有者,使用过程的实践者的代表
ProjectPlans项目计划
projectmanager,programmanager,businesssponsor,marketingorsalesrepresentative,technicallead,qualityassurancemanager项目经理,产品经理,需求提岀者,市场或销售代表,技术负责人,质量保证工程师
RequirementsSpecification需求规格说明书
requirementsanalyst,projectmanager,architect,designer,systemtestengineer,qualityassurancemanager,userormarketingrepresentative,documentationwriter,subjectmatter
expert,technicalsupportrepresentative需求分析师,项目经理,架构师,设计师,系统测试工程师,质量保证经理,用户或市场代表,文档编写者,业务专家,技术支持代表
SourceCode源代码
programmer,designer,unittestengineer,maintainer,
requirementsanalyst,codingstandardsexpert程序员,设计师,
单元测试工程师,维护者,需求分析师,编码标准专家
SystemTechnical
Documentation系统技术文档
author,projectmanager,maintainer,programmer仓U建者,项目
经理,维护者,程序员
TestDocumentation测试文档
testengineer,programmer(unittesting)orarchitect
(integrationtesting)orrequirementsanalyst(systemtesting),
qualityassurancerepresentative测试工程师,程序员(单元测试)或架构师(集成测试)或需求分析师(系统测试),质量保证代表
UserInterfaceDesign用户界
面设计
userinterfacedesigner,requirementsanalyst,user,
applicationdomainexpert,usabilityorhumanfactorsexpert,
systemtestengineer用户界面设计师,需求分析师,用户,应用领
域专家,可用性或人体专家,系统测试工程师
UserManual用户手册
ocumentationwriter,requirementsanalyst,userormarketingrepresentative,systemtestengineer,maintainer,designer,instructionaldesigner,trainer,technicalsupport
representative文档编写者,需求分析师,用户或市场代表,系统测
试工程师,维护人员,设计师,用户教育设计师,培训师,技术支持代表
5.InspectionProcedure(评审步骤)
Participants参与者
Therolesandresponsibilitiesshownbelowpertaintotheinspectionprocess.Allparticipantsareinspectors,inadditiontoanyspecializedroletheymighthave.Atleastthreeparticipants,includingtheauthor,arerequiredforaninspection.Ifonlythreepeopleparticipateinaninspection,themoderatorshallalsoserveasrecorderorreader.Theauthormaynotserveasreader,moderator,orrecorder.下面是评审过程中涉及的角
色及责任。
所有参与者除了自身担任的特定角色外,也都是检查者。
一次评审需要
至少三个参与者,包括创建者。
如果只有三个人参与评审,那么评审负责人还要兼作记录人或阅读人。
创建者一般不作阅读人,评审负责人或记录人。
Role角色
Responsibilities责任
Author
创建者
•Creatorormaintaineroftheworkproducttobeinspected.Initiatestheinspectionprocessbyaskingthepeerreviewcoordinatortoassignamoderator.
•被评审的工作产品的创建者或维护者请求同行评审协调者分配一位评审负责人,从而发起评审过程。
•Stateshisorobjectivesfortheinspection.
•陈述评审目标•Deliversworkproductanditsspecificationorpredecessordocumenttomoderator.
•提交工作产品及其规范或以往的文档给评审负责人。
•Workswithmoderatortoselectinspectorsandassignroles.
•与评审负责人一起选择检查者,并分配角色。
•AddressesitemsontheIssueLogandTypoLists.
•对应问题日志和微错清单上的项目。
•Reportsreworktimeanddefectcountstomoderator.
•向评审负责人报告返工时间和缺陷数。
Moderator
评审负责人
•UsesInspectionModerator'sChecklistasaworkaid.
•使用评审负责人检查表作为工作辅助。
•Plans,schedules,andleadstheinspectionevents.
•计划,安排,组织评审活动。
•Workswithauthortoselectinspectorsandassignroles.
•与创建者一起选择检查者,并分配角色。
•Assemblesinspectionpackageanddeliversitto
inspectorsatleast3dayspriortotheinspectionmeeting.
•提前评审会议至少三天,将评审项目打包并发送给检查者。
•Determineswhetherpreparationissufficienttoholdthemeeting.Ifnot,reschedulesthemeeting.
•确定会议准备是否充分。
如果不充分,重新安排会议时间。
•Facilitatesinspectionmeeting.Correctsanyinappropriatebehavior.Solicitsinputfrominspectorsasreaderpresentseachsectionoftheworkproduct.Recordsanyactionitemsorsideissuesthatariseduringtheinspection.
•促进评审会议进行。
纠正任何不适当的行为。
随着阅读人展现工作产品的各部分,引导检查者提岀问题。
记录评审过程中提出的行动决议或问题。
•Leadsinspectionteamindeterminingtheworkproductappraisal.
•领导评审小组确定工作产品的评估结果。
•Servesasverifierordelegatesthisresponsibilitytosomeoneelse.
•作为审核者或指派其他人承担该责任。
•DeliverscompletedInspectionSummaryReporttotheorganization'speerreviewcoordinator.
•提交完成的评审总结报告给组织的同行评审协调者。
Reader
阅读人
Presentsportionsoftheworkproducttotheinspectionteamtoelicitcomments,issues,orquestionsfrominspectors.
向评审小组展示工作产品的各部分,弓|导检查者进行评论,提岀问题或疑问。
Recorder
记录人
Recordsandclassifiesissuesraisedduringinspectionmeeting.记录并分类评审会议中提出的问题。
Inspector
检查者
Examinesworkproductpriortotheinspectionmeetingtofinddefectsandprepareforcontributingtothemeeting.Recordspreparationtime.Participatesduringthemeetingtoidentifydefects,raiseissues,andsuggestimprovements.在评审会议之前检查工作产品,发现其缺陷,为参加评审会议做准备。
记录准备时间。
参加评审,识别缺陷,提岀问题,给岀改进建议。
Verifier
审核者
Performsfollow-uptodeterminewhetherreworkhasbeenperformedappropriatelyandcorrectly.
进行跟踪,确认返工工作被正确执行。
PeerReview
Coordinator
同行评审协调者
Custodianoftheproject'sinspectionmetricsdatabase.
MaintainsrecordsofinspectionsconductedanddatafromtheInspectionSummaryReportforeachinspection.
Generatesreportsoninspectiondataformanagement,processimprovementteam,andpeerreviewprocessowner.
项目评审度量数据库的