软件项目程序文档合理工作浅析
0引言
文档存软件项目整生命周期中软件项目组成部分文档理软件项目质量控制方式软件项目理忽视部分容然重结果轻程直软件项目中存弊病轻视文档理典型例子惯时整理档总觉重需什文档时候惯问会杂乱章信息中查询花费量时间精力提高软件项目成功率文档理必须引起高度重视兴讨邮件网聊天传阅资料等文档量定期备份整理应该做天回顾信息时进行文档类建立信息索引提高查询速度效率
1程序文档合基概念提出
规范文档系统应包括属性：够准确描述软件简单易懂够迅速进行错误定位影响分析时修正设计够提高软件维护质量方便程序修改时理解程序出软件项目中文档程序密分紧密结合程序文档合概念基提出概念提出软件项目终产品——软件成真正意义软件程序+文档程序包含文档文档集成程序中文档成程序基表现形式
2软件项目程序文档合基求流程
21基求
软件项目理程中利开展程序文档合理应满足基求：
①选择开发环境时仅考虑环境设计开发完美支持考虑维护文档支持②软件员设计开发程中考虑便维护文档检索程序文档存储位置系统中③相工具进行程序文档书写检索编写维护程序时形成文档书写文档时编写维护程序④程序文档合理工作仅存系统设计开发阶段存系统维护阶段贯穿软件项目整生命周期
22技术流程
(1)文档时嵌入存储程序中根程序文档合概念文档程序中提取求文档必须存放程序中甚文档作固源代码部分正常情况程序文档应分存放编程象表字段中编译运行时分离文档时嵌入存储程序中实际做程序文档结合编程象中结合统开发环境中时保证修改代码时时修改文档修改文档时时工检查修改程序次文档生成修改中会丢失手工输入文档信息
(2)程序中做文档检索模块单象构件检索方式采部分文档存放编程象中源代码起检索维护种检索分析维护单构件象提供文档支持通建立种视图编写程序整系统进行文档检索获取完成整系统分析整系统进行实时文档支持检索模块包括构件说明数描述构件构件间构件数间关系属性进行描述提高文档检索性易性连贯性保证文档更加效解决维护问题更加便捷
(3)寻找程序文档合佳方法表现标准掌握时刻养成惯国家软件标准文档样式建立文档模板模板生成更新文档利合成软件进行创建编辑印
二表现开发工具选择基OLE等技术文档利Word等文档处理软件维护改进中方便维护影响分析记录维护进程生成文档便识取构件分析形成结构文档程文档三表现构件环境根述分析文档分布获取开发环境提出求开发环境应该设计工具开发工具集成量采基CASE技术开发环境设计开发维护程中形成文档植入程序代码中文档成程序部分
23理流程
程序文档合软件项目理项目理程基致通合理组织利切利程序设计理念需求信息相关文档方案等资源计划成计划进度完成计划求目标面项目计划项目控制期理三部分分程序文档合软件项目理进行述
(1)项目计划软件项目进入系统实施启动阶段工作容包括：项目实施范围确定工作成果定义实施程风险评估时间计划制订成预算计划制订力资源
计划制订等工作中常常会出现重程序轻文档问题应注意问题：
①程序文档合明确列入项目范围产品范围提程序必然包含文档
②评估项目实施程中风险时技术理等方面考虑程序文档合存风险例技术方面风险包括开发环境支持开发员惯等
③制订进度成资金计划时程序文档合留出余例制订进度计划时仅考虑程序开发进度考虑相伴文档开发进度
④通培训招聘等方式力资源程序文档合工作做准备足够员保障工作利开展相关员够事工作项目计划阶段第项计划活动估算项计划活动决定项目工作进展估算容包括项目持续时间工作量员需求等基估算项目资金需求然必须估算需资源(硬件软件)涉风险软件项目持续时间工作量估算基软件规模预测基础目前软件项目中常规模度量方法代码行(LOC)法功点(FP)法程序文档合软件项目中采种度量方法均应加入项容文档考虑例LOC方法时仅衡量代码行衡量应文档少复杂程度软件规模度量基础种种技术软件项目工作量进行估算技术分两类：分解验建模常规分解技术需划分出软件功接着估算实现功需程序规模月数实施程序文档合时仅考虑软件功程序规模应文档工作量计算进验建模技术建立模型时需文档工作验参
(2)项目实施程控制阶段务已详细分解总体解决方案技术框架已确立详细设计目针某特定模块象根需求技术框架求模块间接口实现相应功伴完成相应文档做文档程序步
该阶段中评审项重容评审评审组负责通常组部评审会方式进行参项目组部员负责开发者介绍工作情况程序设计思路文档工作成果概等解设计质量进行评审编码调试阶段尤重编码阶段需编码工作结束进行代码文档审核项工作非常重应该项目组技术负责完成审核目检验代码正确性需编码否规范文档否满足求进行审核容包括：①
变量包方法等命名否符合规相应文档说明注释否完整否符合规范②代码读性编写风格否符合规范否时生成相应文档③否明显造成系统运行低效率处理方法④公变量定义相应文档否规范⑤否时做程序文档合工作否全面测试系统正常工作提供坚实基础
(3)期理项目验收标志期理整项目生命周期中重环节般说软件项目验收包括两阶段第阶段验收测试验收测试成功结束会阶段试运行阶段两阶段全部结束整项目算真正结束该软件进入运行维护期验收测试应软件需求质量求进行测试验收需方参验收容般软件项目常规容外文档质量程序文档合效果进行验收项目通验收软件投入进入维护阶段期理工作检验程序文档合工作效性实践环节需注意方面进行维护时需前面程序文档合工作成果方面程序文档合软件项目言维护贯穿软件整生命周期维护阶段仅文档维护文档程序文档合维护着需求变化变化满足求软件系统更加完善修改扩充工作更心应手
文档香网(httpswwwxiangdangnet)户传
《香当网》用户分享的内容，不代表《香当网》观点或立场，请自行判断内容的真实性和可靠性！
该内容是文档的文本内容，更好的格式请下载文档
0引言
文档存软件项目整生命周期中软件项目组成部分文档理软件项目质量控制方式软件项目理忽视部分容然重结果轻程直软件项目中存弊病轻视文档理典型例子惯时整理档总觉重需什文档时候惯问会杂乱章信息中查询花费量时间精力提高软件项目成功率文档理必须引起高度重视兴讨邮件网聊天传阅资料等文档量定期备份整理应该做天回顾信息时进行文档类建立信息索引提高查询速度效率
1程序文档合基概念提出
规范文档系统应包括属性：够准确描述软件简单易懂够迅速进行错误定位影响分析时修正设计够提高软件维护质量方便程序修改时理解程序出软件项目中文档程序密分紧密结合程序文档合概念基提出概念提出软件项目终产品——软件成真正意义软件程序+文档程序包含文档文档集成程序中文档成程序基表现形式
2软件项目程序文档合基求流程
21基求
软件项目理程中利开展程序文档合理应满足基求：
①选择开发环境时仅考虑环境设计开发完美支持考虑维护文档支持②软件员设计开发程中考虑便维护文档检索程序文档存储位置系统中③相工具进行程序文档书写检索编写维护程序时形成文档书写文档时编写维护程序④程序文档合理工作仅存系统设计开发阶段存系统维护阶段贯穿软件项目整生命周期
22技术流程
(1)文档时嵌入存储程序中根程序文档合概念文档程序中提取求文档必须存放程序中甚文档作固源代码部分正常情况程序文档应分存放编程象表字段中编译运行时分离文档时嵌入存储程序中实际做程序文档结合编程象中结合统开发环境中时保证修改代码时时修改文档修改文档时时工检查修改程序次文档生成修改中会丢失手工输入文档信息
(2)程序中做文档检索模块单象构件检索方式采部分文档存放编程象中源代码起检索维护种检索分析维护单构件象提供文档支持通建立种视图编写程序整系统进行文档检索获取完成整系统分析整系统进行实时文档支持检索模块包括构件说明数描述构件构件间构件数间关系属性进行描述提高文档检索性易性连贯性保证文档更加效解决维护问题更加便捷
(3)寻找程序文档合佳方法表现标准掌握时刻养成惯国家软件标准文档样式建立文档模板模板生成更新文档利合成软件进行创建编辑印
二表现开发工具选择基OLE等技术文档利Word等文档处理软件维护改进中方便维护影响分析记录维护进程生成文档便识取构件分析形成结构文档程文档三表现构件环境根述分析文档分布获取开发环境提出求开发环境应该设计工具开发工具集成量采基CASE技术开发环境设计开发维护程中形成文档植入程序代码中文档成程序部分
23理流程
程序文档合软件项目理项目理程基致通合理组织利切利程序设计理念需求信息相关文档方案等资源计划成计划进度完成计划求目标面项目计划项目控制期理三部分分程序文档合软件项目理进行述
(1)项目计划软件项目进入系统实施启动阶段工作容包括：项目实施范围确定工作成果定义实施程风险评估时间计划制订成预算计划制订力资源
计划制订等工作中常常会出现重程序轻文档问题应注意问题：
①程序文档合明确列入项目范围产品范围提程序必然包含文档
②评估项目实施程中风险时技术理等方面考虑程序文档合存风险例技术方面风险包括开发环境支持开发员惯等
③制订进度成资金计划时程序文档合留出余例制订进度计划时仅考虑程序开发进度考虑相伴文档开发进度
④通培训招聘等方式力资源程序文档合工作做准备足够员保障工作利开展相关员够事工作项目计划阶段第项计划活动估算项计划活动决定项目工作进展估算容包括项目持续时间工作量员需求等基估算项目资金需求然必须估算需资源(硬件软件)涉风险软件项目持续时间工作量估算基软件规模预测基础目前软件项目中常规模度量方法代码行(LOC)法功点(FP)法程序文档合软件项目中采种度量方法均应加入项容文档考虑例LOC方法时仅衡量代码行衡量应文档少复杂程度软件规模度量基础种种技术软件项目工作量进行估算技术分两类：分解验建模常规分解技术需划分出软件功接着估算实现功需程序规模月数实施程序文档合时仅考虑软件功程序规模应文档工作量计算进验建模技术建立模型时需文档工作验参
(2)项目实施程控制阶段务已详细分解总体解决方案技术框架已确立详细设计目针某特定模块象根需求技术框架求模块间接口实现相应功伴完成相应文档做文档程序步
该阶段中评审项重容评审评审组负责通常组部评审会方式进行参项目组部员负责开发者介绍工作情况程序设计思路文档工作成果概等解设计质量进行评审编码调试阶段尤重编码阶段需编码工作结束进行代码文档审核项工作非常重应该项目组技术负责完成审核目检验代码正确性需编码否规范文档否满足求进行审核容包括：①
变量包方法等命名否符合规相应文档说明注释否完整否符合规范②代码读性编写风格否符合规范否时生成相应文档③否明显造成系统运行低效率处理方法④公变量定义相应文档否规范⑤否时做程序文档合工作否全面测试系统正常工作提供坚实基础
(3)期理项目验收标志期理整项目生命周期中重环节般说软件项目验收包括两阶段第阶段验收测试验收测试成功结束会阶段试运行阶段两阶段全部结束整项目算真正结束该软件进入运行维护期验收测试应软件需求质量求进行测试验收需方参验收容般软件项目常规容外文档质量程序文档合效果进行验收项目通验收软件投入进入维护阶段期理工作检验程序文档合工作效性实践环节需注意方面进行维护时需前面程序文档合工作成果方面程序文档合软件项目言维护贯穿软件整生命周期维护阶段仅文档维护文档程序文档合维护着需求变化变化满足求软件系统更加完善修改扩充工作更心应手
文档香网(httpswwwxiangdangnet)户传
《香当网》用户分享的内容，不代表《香当网》观点或立场，请自行判断内容的真实性和可靠性！
该内容是文档的文本内容，更好的格式请下载文档