C代码编辑器工程

1、项目名称：C代码编辑器1 项目参与人员项目经理：李梦需求分析师：陈妙珊产品设计师：吴濛架构师：曹正勇编码员：夏双奇、李梦、陈妙珊、吴濛、曹正勇、李发禹测试员：李发禹目录 TOC o 1-3 h z u HYPERLINK l _Toc306567862 项目名称：学生成绩管理系统 PAGEREF _Toc306567862 h 1 HYPERLINK l _Toc306567863 1 项目参与人员 PAGEREF _Toc306567863 h 1 HYPERLINK l _Toc306567864 目录 PAGEREF _Toc306567864 h 2 HYPERLINK l _Toc3

2、06567865 1 Inception PAGEREF _Toc306567865 h 4 HYPERLINK l _Toc306567866 1.1 Use-Case Model (用例模型) PAGEREF _Toc306567866 h 4 HYPERLINK l _Toc306567867 1.1.1 Brief format PAGEREF _Toc306567867 h 4 HYPERLINK l _Toc306567868 1.1.2 10-20% core picked requirement (fully dressed) PAGEREF _Toc306567868 h 5

3、 HYPERLINK l _Toc306567869 1.2 Supplementary Specification (补充规格说明) PAGEREF _Toc306567869 h 6 HYPERLINK l _Toc306567870 1.2.1 Revision History (修订历史) PAGEREF _Toc306567870 h 6 HYPERLINK l _Toc306567871 1.2.2 Introduction (简介) PAGEREF _Toc306567871 h 6 HYPERLINK l _Toc306567872 1.2.3 Functionality (功

4、能性) PAGEREF _Toc306567872 h 6 HYPERLINK l _Toc306567873 1.2.4 Usability (可用性) PAGEREF _Toc306567873 h 7 HYPERLINK l _Toc306567874 1.2.5 Reliability (可靠性) PAGEREF _Toc306567874 h 7 HYPERLINK l _Toc306567875 1.2.6 Performance (性能) PAGEREF _Toc306567875 h 7 HYPERLINK l _Toc306567876 1.2.7 Supportabilit

5、y (可支持性) PAGEREF _Toc306567876 h 7 HYPERLINK l _Toc306567877 1.2.8 Implementation Constraints (实现约束) PAGEREF _Toc306567877 h 7 HYPERLINK l _Toc306567878 1.2.9 Purchased Components (购买的组建) PAGEREF _Toc306567878 h 7 HYPERLINK l _Toc306567879 1.2.10 Interfaces (接口) PAGEREF _Toc306567879 h 7 HYPERLINK l

6、 _Toc306567880 1.2.11 Application-Specific Domain (Business) Rules (应用领域规则) PAGEREF _Toc306567880 h 8 HYPERLINK l _Toc306567881 1.2.12 Legal Issues (法律问题) PAGEREF _Toc306567881 h 8 HYPERLINK l _Toc306567882 1.2.13 Information in Domains of Interest (所关注领域内的信息) PAGEREF _Toc306567882 h 8 HYPERLINK l _

7、Toc306567883 1.3 Vision (预景) PAGEREF _Toc306567883 h 8 HYPERLINK l _Toc306567884 1.3.1 Revision History (修订历史) PAGEREF _Toc306567884 h 8 HYPERLINK l _Toc306567885 1.3.2 Introduction (简介) PAGEREF _Toc306567885 h 8 HYPERLINK l _Toc306567886 1.3.3 Positioning (定位) PAGEREF _Toc306567886 h 9 HYPERLINK l

8、_Toc306567887 1.3.4 Stakeholder Descriptions (涉众描述) PAGEREF _Toc306567887 h 9 HYPERLINK l _Toc306567888 1.3.5 Product Overview (产品概览) PAGEREF _Toc306567888 h 9 HYPERLINK l _Toc306567889 1.3.6 Summary of System Features (系统特性概要) PAGEREF _Toc306567889 h 9 HYPERLINK l _Toc306567890 1.3.7 Other Requirem

9、ents and Constraints (其它需求和约束) PAGEREF _Toc306567890 h 9 HYPERLINK l _Toc306567891 1.4 Glossary (词汇表) PAGEREF _Toc306567891 h 10 HYPERLINK l _Toc306567892 1.4.1 Revision History (修订历史) PAGEREF _Toc306567892 h 10 HYPERLINK l _Toc306567893 1.4.2 Definitions (定义) PAGEREF _Toc306567893 h 10 HYPERLINK l

10、_Toc306567894 1.5 Business Rules (领域/业务规则) PAGEREF _Toc306567894 h 10 HYPERLINK l _Toc306567895 1.5.1 Revision History (修订历史) PAGEREF _Toc306567895 h 10 HYPERLINK l _Toc306567896 1.5.2 Rule List (规则列表) PAGEREF _Toc306567896 h 10 HYPERLINK l _Toc306567897 1.6 Risk List & Risk Management Plan (风险列表和风险

11、管理计划) PAGEREF _Toc306567897 h 11 HYPERLINK l _Toc306567898 1.7 Iteration Plan (迭代计划) PAGEREF _Toc306567898 h 11 HYPERLINK l _Toc306567899 2 Elaboration PAGEREF _Toc306567899 h 12 HYPERLINK l _Toc306567900 2.1 Domain Models PAGEREF _Toc306567900 h 12 HYPERLINK l _Toc306567901 2.2 System Sequence Diag

12、rams PAGEREF _Toc306567901 h 13 HYPERLINK l _Toc306567902 2.3 Operation Contracts PAGEREF _Toc306567902 h 131 Inception1.1 Use-Case Model (用例模型)1.1.1 Brief format*C代码高亮显示（颜色不可更改）*将来可扩展到其它语言*无限制的撤销、重做*启动速度快（架构需求）*代码折叠*代码格式化代码自动缩进括号匹配查找替换复制粘贴剪切支持多工作窗口界面美观自动换行行数显示，标记同名的词全标记支持快捷键定时保存行数、单词数、字符数统计1.1.2 10

13、-20% core picked requirement (fully dressed)Use Case Name (用例名称)C语言语法高亮显示 (C code Highlighting)Scope (范围)C语言代码编辑器Level (级别)用户目标Primary Actor (主要参与者)进行C语言代码编写工作的用户Stakeholders and Interests (涉众及其关注点)- 编写C语言代码的用户：利用C语言语法高亮功能，使编码工作能更快速、更正确的进行。- 公司：？Preconditions (前提条件)用户正在编辑C语言代码。Success Guarantee (成功保

14、证)当代码输入系统时，能正确的记录代码，并高亮代码。Main Success Scenario (主要场景)Actor Action（参与者的活动或意图）System Responsibility （系统的响应）1. 用户打开C代码编辑器2. 系统开启3. 用户编辑（新增、删除、插入等）C语言代码。4. 系统根据C语言语法，将现有的代码进行高亮显示。重复23步，直到用户终止编辑C代码5. 用户关闭C代码编辑器6. 系统关闭Extensions (扩展)Special Requirements (特殊需求)- 现有的代码被编辑时，能立刻高亮显示更新过后的代码。不管现有代码有多少，不能有延迟。-

15、代码高亮的规则要始终一致，并且合理。- ？- Technology and Data Variation List (技术和数据变元表)Frequency of Occurrence (发生频度)Miscellaneous (杂项)1.2 Supplementary Specification (补充规格说明)1.2.1 Revision History (修订历史)Version (版本)Date (日期)Description (描述)Author (作者)初始草案2011-10-13第一个草案，将在细化阶段进行精华王欢1.2.2 Introduction (简介)本文档记录了C代码编辑器

16、所有未在用例中描述的需求。1.2.3 Functionality (功能性)- 系统将来可扩展到其它语言1.2.4 Usability (可用性)- 支持多窗口操作- 界面美观- 支持快捷键1.2.5 Reliability (可靠性)- 无限制的撤销、重做- 编辑的代码能正确的记录- 支持定时保存1.2.6 Performance (性能)- 启动速度快- 响应速度快1.2.7 Supportability (可支持性)- 能支持Windows和Linux平台1.2.8 Implementation Constraints (实现约束)1.2.9 Purchased Components (

17、购买的组建)1.2.10 Interfaces (接口)1.2.11 Application-Specific Domain (Business) Rules (应用领域规则)参见2 Legal Issues (法律问题)1.2.13 Information in Domains of Interest (所关注领域内的信息)1.3 Vision (预景)1.3.1 Revision History (修订历史)Version (版本)Date (日期)Description (描述)Author (作者)1.3.2 Introduction (简介)*1.3.3 Positi

18、oning (定位)*1.3.4 Stakeholder Descriptions (涉众描述)*1.3.5 Product Overview (产品概览)*1.3.6 Summary of System Features (系统特性概要)*1.3.7 Other Requirements and Constraints (其它需求和约束)*1.4 Glossary (词汇表)1.4.1 Revision History (修订历史)Version (版本)Date (日期)Description (描述)Author (作者)1.4.2 Definitions (定义)Term (术语)De

19、finition and Information (定义和信息)Format (格式)Validation Rules (验证规则)Aliases (别名)1.5 Business Rules (领域/业务规则)1.5.1 Revision History (修订历史)Version (版本)Date (日期)Description (描述)Author (作者)1.5.2 Rule List (规则列表)IDRule (规则)Changeability (可变性)Source (来源)= 1.1 1.5为UP的需求指标 =1.6 Risk List & Risk Management Pla

20、n (风险列表和风险管理计划)1.7 Iteration Plan (迭代计划)Phase name (阶段名)ElaborationIteration order (迭代序号)1NameTime Plan (时间安排)Description (描述)Requirements (需求)2011-10-14详细分析了“代码高亮显示”的需求；基于此建立了领域模型、系统交互图、操作契约Design (设计)2011-10-17 2011-10-19详细设计“代码高亮显示”功能；基于此建立动态的交互图、静态的类图Implementation & Test & Integration & More De

21、sign (实现，测试，集成以及更多的设计)2011-10-20 2011-10-24实现“代码高亮显示”，得到代码。Final Integration & System Test (最终集成和系统测试)2011-10-25 2011-10-26测试“代码高亮显示”，得到测试报告。Feedback and Documentation (反馈和文档)2011-10-26归纳反馈，书写文档。Next Iteration Plan (下一个迭代计划)2011-10-26讨论和制定下一个迭代计划。2 Elaboration2.1 Domain ModelsPartial Domain Models:

22、Code Highlighting Use Case2.2 System Sequence DiagramsPartial SSD: Code Highlighting Scenario2.3 Operation ContractsContract CO1: openOperationopenCross ReferencesUse Case: C code HighlightingPreconditionsnonePostconditions- A CodeEditor instance editor was created (instance creation).Contract CO2:

23、editCodeOperationeditCodeCross ReferencesUse Case: C code HighlightingPreconditionsProgrammer (User) has opened System, and Programmer is editing code.Postconditions- A Code instance code was created (instance creation).- became name (attribute modification).- code.content became content (attribute modification).- code was associated with current Co