全部博文(389)
分类: Oracle
2014-11-04 16:53:46
编写ORACLE性能报告的九大注意事项
一份好的报告不但能清楚的反映当前的问题,而且也是一个项目的重要成果之一.
总结了一下在文档编写过程的九大注意事项.
1,文档结构清楚,有很好的上下层次关系.一般的内容应当包括;目标,当前的各项
性能统计;问题分析;改进建议;实施情况;结果反馈;总结.
2,文档尽量要以数据说话,对于不是肯定的结论尽量不要写.避免出现估计,大概和
可能这样模糊不清的词语;
3,可以对数据进行图形化展现,让阅读者感觉到一目了然,从解读枯燥的技术数据中解
脱出来;
4,不要犯很低级的错误.文档就是一个项目的成果,特别是对于第三方服务的公司来说
文档基本上就代表了是产品,对信誉非常重要.
5,文档尽量少出现命令的语气,比如你们该怎么样之类的.而是要使用我们这样做更好
的语句.
6,对于有问题的地方,少直接指出,尽量用更加委婉的语气,当客户拿着你的报告给
应用开发或是其也相关人员阅读时,要考虑到其他的人感受,得饶人处且饶人.
7,文档不宜做长篇大论,要直切问题的本质.不要出现泛泛空淡的东西。要针对目前的现
状列出切实可行的方案.
8,考虑各方面实现解决方案的难度.如果我们一心只想着要别人改东西,而不考虑对方
的难处,很容易引起客户或是第三方的反感.
9,对于所有的结论都有要很强的证据支证,方式可以是数据,图形或权威专家的结论.