南京大学-软件工程-20 Software Delivery

1、Computing and SE IIChapter 20: Software DeliverySoftware Institute, NJUMain ContentsnInstallation and DeploymentnUser Training and DocumentationnProject Review1. Installation and DeploymentnSimple software needs installationnComplex software and its environments needs deployment思考n在前期开发工作中，没有为“程序安装与

2、部署”而进行的工作？创建安装包的步骤n1 确定安装环境qOS、NT、DB、Container、特定文件、注册表n2 列举安装清单q确定在成功安装之后用户会在什么地方发现什么东西n文件、环境、初始数据、注册表n3 设计和建立安装包n4 测试安装包5n例如，超市销售系统MSCS安装包可以按照下列步骤建立：(1)检查操作系统环境；(2)检查JDK，如果没有合适的JDK，则提醒用户安装JDK；(3)检查数据库管理系统软件，如果没有合适的数据库管理系统软件，则提醒用户进行安装；(4)设置数据库管理系统连接参数；(5)连接数据库管理系统，创建MSCS的数据库；(6)拷贝文件；(7)设置初始化数据，包括数据

3、库系统连接参数和MSCS的默认管理帐号；(8)安装成功。6部署n部署通常是由开发人员直接操纵软件产品的目标环境，使得软件产品能够在目标环境中正常运行。n部署的过程中通常需要执行安装任务，但是还有很多比安装复杂得多的其他任务，例如：安装、设置或调整操作系统，尤其是权限管理参数；安装、设置和调整数据库系统，包括新建数据库和设置访问权限；安装和设置库文件、应用服务器等应用环境。7部署的步骤n1.确定部署环境n2.确定部署任务n3.完成部署准备n4. 执行部署任务81.确定部署环境n和安装一样，软件部署要首先要需要确定部署的目标环境，当然它比安装要求的更高一些。它需要对目标环境进行调查分析，搞清楚部署

4、前的环境细节，然后才能与软件产品需要的环境细节进行比较，才能明确需要执行的部署任务。n具体来说，软件部署需要了解服务器与网络拓扑、安全控制与权限管理、软硬件系统的配置信息等。92.确定部署任务n将软件产品需要的目标环境与部署前的环境进行比较，分析二者之间的差距，并将其确立为部署的任务。n确定任务之后，还需要以渐进的方式安排任务之间的执行次序。例如，先安装和配置操作系统，然后安装和配置相应的软硬件系统，最后完成软件产品的安装与配置，等等。103 完成部署准备n有些部署工作可以完全依靠现场执行，但多数的部署任务需要进行一定的事前准备，尤其是要综合考虑部署工作可能出现的各种情况，制定完备的应对方案。

5、q预期可能出现的问题并为之做出准备114 执行部署任务n按照准备的计划，执行相应的部署任务。12Main ContentsnInstallation and DeploymentnUser Training and DocumentationnProject Review2. User Training and DocumentationnIt is more than just putting the system in placenIt is also helping users to understand and feel comfortable with the systemqTrai

6、ningqDocumentationTrainingnUsers: exercise the main system functionsnOperators: perform supplementary functionsqcreate back up copies of data filesqdefine who has access to the systemUser TrainingnIntroduces the primary functionsqRecord management: record creation, deletion, retrieval, sortingqNavig

7、ation through the systemqNo need to internal mechanism (e.g., sorting algorithms, data structures)nRelates how the functions are performed now, how to perform later with the new systemqNeed to take into account the difficulty of transition learningOperator TrainingnFocuses on support functions and a

8、ddresses how the system works rather than what the system doesnRuns in two levelsqhow to bring up and run the new systemqhow to support usersDocumentationConsidering the AudiencesnNeed to understand the intended audienceqUsersqOperatorsqCustomer staff qOther member of development teamnDesign differe

9、nt documents for different audienceqInclude a “gentle” introductionDocumentationTypes of DocumentationsnUsers manualnOperators manualnOther documentation: Programmer guidenDocumentationUser Helps and TroubleshootingnReference documentsq指导模式nFailure message reference guideq参考模式nOnline helps files用户文档

10、的内容组织n指导模式根据用户的任务组织程序规程，相关的软件任务组织在相同的章节或主题。指导模式要先描述简单的、共性的任务，然后再以其为基础组织更加复杂的任务描述。n参考模式按照方便随机访问独立信息单元的方式组织内容。例如，按字母顺序排列软件的命令或错误消息列表。n如果文档需要同时包含两种模式，就需要将其清楚地区分成不同的章节或主题，或者在同一个章节或主题内区分为不同的格式。21用户文档的要素【IEEE】章节章节是否必须是否必须标识信息标识信息是目录目录（正文超过8页时）是图表目录图表目录可选引言引言是文档使用信息文档使用信息是操作操作模式模式是操作规程操作规程是（指导模式）软件命令信息软件命令

11、信息是（参考模式）错误信息与问题解决错误信息与问题解决是术语表术语表（文档中有陌生名词时）是相关信息源相关信息源可选导航特征导航特征是索引索引（文档正文超过40页时）是搜索能力搜索能力（电子文档中）是22nAn User Manual TemplateDocumentationOperators ManualsnHardware and software configurationnMethods of granting and denying access to a usernProcedures for adding and removing peripherals from system

12、nTechniques for duplicating or backing up files and documentsDocumentationGuidelines for Failure MessagesnThe name of the code component executing when the failure occurrednThe source code line number in the component that was executingnThe failure severity and its impact on the systemnThe contents

13、of any relevant system memory or data pointers, such as registers or stack pointersnThe nature of the failure, or a failure message number (for cross-reference with the failure message reference guide)DocumentationExample Failure MessagesnThe failure messageFAILURE 345A1: STACK OVERFLOWOCCURRED IN:

14、COMPONENT DEFRECDAT LINE: 12300SEVERITY: WARNINGREGISTER CONTENTS: 0000 0000 1100 1010 1100 1010 1111 0000PRESS FUNCTION KEY 12 TO CONTINUEnThe reference guide entryFailure 345A1: Stack overflow.This problem occurs when more fields are defined for a record than the system can accommodate. The last f

15、ield defined will not be included in the record. You can change the record size using the Record Maintenance function on the Maintenance menu to prevent this failure in the future.Main ContentsnInstallation and DeploymentnUser Training and DocumentationnProject ReviewProject ReviewnProject Reviews a

16、re examinations of projects or events or activities in a projectnCan occur at any time during a projectnBut the review in project close is most importantnCan be used to evaluate the success of both events and projects. Why Do Project ReviewnLessons learned from Project Reviews are useful from many p

17、erspectives. nThe real benefit from Project Reviews is the opportunity to step back and take a deeper look into the system. Target Beneficiaries of ReviewsnManagementnTeamsnIndividual Contributors/Participating institutionsTarget Beneficiaries of ReviewsnManagementqManagement benefits by gaining ins

18、ight into the way that the project unit/team is working. qIt enhances our ability to distinguish between common causes and special causes of variation in the project development process. qIt builds common metrics in order to track efforts on the project. Target Beneficiaries of ReviewsnTeams qTeams

19、learn how roles and responsibilities can be redesigned to enhance attainment of results. qIt provides a historical link through which theory and knowledge can be built or accumulated. qIt provides a structured process for developing shared learning and shared meaning. Target Beneficiaries of Reviews

20、nContributors/Participating InstitutionsqIndividual contributors learn how to improve tasks and deliverables to increase effectiveness. qIt increases understanding of key elements needed to support productive work. qIt helps us see how our actions impede or enhance the success of the project. qIt re

21、veals weakness and strengths in our project documentation and communication methods. 项目评价的内容n常见的项目评价针对四个方面：q项目管理：可以帮助建立对项目的更准确认知，例如常见的管理问题与偏差、时间与成本耗费分布等。q产品：可以帮助开发者建立对产品的更准确认知，提高产品的开发经验。q团队：可以帮助开发者更好地组织分工，也可以帮助团队建立更好的沟通与交流途径。q个人：可以帮助开发者更准确认知自己的生产力，学习常见问题及其处理方法，了解自己的长处和不足并持续提高。34项目评价方法n评审q项目评审通过评审重要项目制品的方法来评价项目，这些重要制品包括项目计划、管理文档、会议记录、历史数据等。n度量数据分析q度量数据可以提供丰富的信息，