现在的位置: 首页 > 综合 > 正文

软件项目开发应写的13类文档——sun软件学院转载(转)

2012年11月22日 ⁄ 综合 ⁄ 共 2165字 ⁄ 字号 评论关闭

在软件项目开发过程中,应该按软件开发要求撰写十三类文档,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性!

需求阶段

1、可行性分析报告

说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。

2、项目开发计划

为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

3、软件需求说明书(软件规格说明书)

对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的,也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护系统数据文件做好准备。

设计阶段

4、概要设计说明书

该说明书是概要实际阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计提供基础。

5、详细设计说明书

着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。

开发阶段

6、开发进度月报

该月报系软件人员按月向管理部门提交的项目进展情况报告,报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

测试阶段

7、测试计划

为做好集成测试和验收测试,需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

8、测试分析报告

测试工作完成以后,应提交测试计划执行情况的说明,对测试结果加以分析,并提出测试的结论意见。

收尾阶段

9、用户操作手册

本手册详细描述软件的功能、性能和用户界面,使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识,特别是操作方法的具体细节。

10、项目开发总结报告

软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力,此外,还需对开发工作做出评价,总结出经验和教训。

11、软件维护手册

主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明,便于软件的维护。

维护阶段

12、软件问题报告

指出软件问题的登记情况,如日期、发现人、状态、问题所属模块等,为软件修改提供准备文档。

13、软件修改报告

软件产品投入运行以后,发现了需对其进行修正、更改等问题,应将存在的问题、修改的考虑以及修改的影响作出详细的描述,提交审批。

原稿出自:www.china-cio.com,转载请注明出处。

 

 

 

请不要缩在项目或产品的“龟壳”里面——sun软件学院转载

 

也许是呆在“龟壳”里的时间太久了,以致于当下是个什么世道都快搞不清楚了。当开发者一天到晚忙于开发而不知周围环境变化的时候,就成了这种情况。也许在技术上已突飞猛进,但其它方面能力却在随之退化。

其时做产品过程中一直存在一个比较有意思的地方,就是要同时考虑市场和技术。不仅是同行业的
发展,竞争对手的动作,有时还要考虑处于相关上下游产业链条中的一些公司和渠道,以及使用你产品的客户所处行业的相关情况。没有人能告诉你做什么是对的,
有时完全是跟着感觉甚至竞争对手走。

当客户找上门来与你沟通,要你做这做那时,有些相法是可以接受的,有些则属于是异想天开,当
然还有其它让你啼笑皆非甚至BT的需求,因为从他们的角度出来,只要能赚钱,“一切皆有可能”,一切皆应存在。这时你就要结合自己的专业背景和市场分析能
力给他们讲你对这些功能或问题的看法,并了解客户提出这个功能或想法的初衷,以及评估与之相关解决方案的可行性,论证自己的想法。也许在一轮甚至几轮交流
之后,你会发现开发这些功能并不像你一开始所遇想的那么复杂(或者简单)。只是当初把它想的过于复杂或者简单了。我以前就爱犯一种毛病,急于编码,到眼下
看来,很多的时间精力都被浪费了,其实用户也许就是要一个小功能,而我却不管不顾的将框架模式用了一大堆,导致过度设计严重,甚至背负了"拿客户练手“之
嫌疑。而整天缩在项目或产品中就可能出现这种只想编码不想其他的倾向。而一但与用户接触后,才被用户用凉水泼醒。

而有些整天缩着头在"龟壳"中写垃圾代码的同事,也别以为穿着"马甲"出来别人就不 知道你是谁了,丑媳妇早晚要见公婆。等到向客户或用人公司展示你的”作品“和思路时,大板子依旧会拍在你的屁股上。

我希望项目和产品背后的开发者走出来,超码走到同行中来交流你的设计思想和心得,这样一方面锻炼自己的表达能力,一方面也能验证自己法,增强自信心。当然有些时候会被一些同行尖刻的指出其中弊端,甚至还有人身攻击。不过要么在挨骂中灭亡,要么在挨骂中爆发。

爆发分两种,一种是直接反唇相击,不管脑袋屁股的一股脑顶回去。一种是踏实下来找原因,如果是自己做的不对,认错并求得谅解,并在后续开发中进行纠正,如果自己没问题则善意的指出对方观点中存在的问题,或共同寻求解决方案,与客户与同行一起成长。

不想再产品和项目中潜水了,时间长了之后真的会丧失在 “太阳下以及陆地上生活的能力“。

在从事开发多年之后,开始尝试观察圈子之外的环境,去扩展自己的天地。

原稿出自:www.china-cio.com,转载请注明出处。

抱歉!评论已关闭.