经验案例写作建议.doc

《经验案例写作建议.doc》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、经验案例写作建议通过对经验案例历史库的走读，从文档本身的易读性和易参考借鉴性岀发，我们初步给出了在案例写作方面的建议，主要包括案例内容方面，语言组织方面，文章架构方面。1.经验案例的内容方面，我们认为较好的经验案例应具有以下特征：•有实际项目支持，可以涉及项目开发和维护过程中遇到的困难、成功经验和失败教训，并对后续开发有指导和借鉴意义。•学习心得、知识介绍性质的文章不作经验案例处理。涉及到产品应用方案的经验案例，不能单纯介绍性描述，应详细说明该方案的优缺点，能提炼出具有指导作用的检查点。2.在经验案例的写作技巧上，我们认为较好的经验案例应具

2、有以下特征:7分条目写、设置小标题、多用图表、需说明的可加脚注7用语简洁，篇幅不一定要长，只要能把案例描述清楚7涉及到技术词汇时，尽量用标准的专业术语7重要的图表直接写在正文中，不作为附件7附件中附上有价值的参考文献或资料7L代码相关的，只需列出关键代码，并尽量附以文字说明和注释，町在附件里附上详细代码7表述准确和完整，避免大量使用“等”、“可能”、“大概”这些模糊类的词语X知识及概念性的介绍（例如：在进入正文之前，我们先简单了解儿个名词：XXX）X空泛的总结（例如：在今后的编码中，要综合多方面因素來考虑问题）X通篇的代码（例如：直接把修改

3、前后的大段代码罗列出来）X一篇经验案例包含几个毫不相关的问题，每个问题只简单描述（这种情况可以分成几篇经验案例来写，把每个问题描述地详细些）X过多的主观描述、主观判断（例如：当时我就愣是调了有3个小时之久没有调通…）3・目前研发部提交的经验案例大致可以分为以下几类，对相关类别提出了以下建议并给出示范案例：3.1解决了产品的某个缺陷或改进了产品的某个性能，并运用到实际生产中去。也就是说可以作为解决一个具体问题的案例。•案例可以是提供了某个检查项，或者解决问题过程可以为后来人提供参考。•可以是一个单独的问题，或者是一系列相关的问题。•可以是改进

4、了产品的某个性能或是填补了某方面技术的空白，应具有可借鉴性。不包括平时开发中新增的普通功能。（以下提供了示范案例,请留意文档批注,批注将对各个部分怎样填写给出建议）示范案例3.1.doc3.2从过往的大量实践中提炼出来的经验，不能归于某个具体的案例。•可以是对某一系列问题、技巧、技术的总结。•需与实践相关的总结，不包括介绍性的总结。（以下提供了示范案例,请留意文档批注,批注将对各个部分怎样填写给出建议）示范案例3.2.doc3.3方案的对比和选择。•在实际开发中遇到的几个可选方案，最后确定了某个方案。•不包括正在研究且未确定哪个将运用于产品

5、中的方案。（以下提供了示范案例,请留意文档批注,批注将对各个部分怎样填写给出建议）示范案例3.3.doc3.4根据产品的一个异常现象，有一系列的步骤來排查问题：•该步骤和排查问题的思路具有较好的借鉴作用。（以下提供了示范案例，请留意文档批注,批注将对各个部分怎样填写给出建议）示范案例3・4・doc3.5测试组的经验案例较特别，除了包括以上几类外，还存在以下情况：・设计地较好较全面的测试用例，可作为以后进行相关测试的参考。•测试环境或平台搭建的经验。（以下提供了示范案例,请留意文档批注,批注将对各个部分怎样填写给出建议）示范案例3・5.doc