软件包括程序(program)、相关数据(data)及其说明文档(document),一个没有文档的软件称不上是一个完整的软件,在好多时候了解一个软件就是从它的文档开始的,因为大家不可能都去了解程序和数据吧,那是不现实的,但了解文档确是切实可行的。
那么文档都要包含哪些内容呢?个人认为要有系统实现原理、系统结构、设计说明、各种操作说明指导手册等,这些详细的方面就不提了,重点说下文档的层次,一个系统是让各层次的人来用的,有系统管理员、业务管理员、业务操作员、审计人员等其它人员,相应的文档也要区分对象,不同的人使用不同的文档,切记一锅粥就一份文档也不分主次,上面面面俱到什么都有,使用的人也不知道该看那些内容,到最后根本没人看,因为大家看不到自己想要的东西。
对于系统管理员的文档要突出系统实现原理、系统结构、设计说明、维护注意事项等,系统管理员负责整个系统因此必须要掌握整个系统的架构和实现原理,这样系统出故障时才能快速准确的定位到故障所在;业务管理员是负责业务方面的,对于他们的文档要讲清楚业务是如何在系统中实现的,业务实现的注意事项,实现业务的必要操作说明,一些基本的业务故障定位处理等;对于业务操作员重点要讲明白业务是如何操作的,操作中的注意事项,业务操作说明等,可能对于某些特殊的部分也要讲下基本的实现原理,视具体情况而定。
文档怎么写,要视具体情况而定,不一定非要那么严格区分,但最忌讳的就是通篇一律搞形式主义,文档中什么都有突不出重点,最后都不是大家想要的。
浅谈系统文档
原创
©著作权归作者所有:来自51CTO博客作者srsunbing的原创作品,请联系作者获取转载授权,否则将追究法律责任
上一篇:对几个小系统的感想
下一篇:关于rman备份的问题
提问和评论都可以,用心的回复会被更多人看到
评论
发布评论
相关文章
-
浅谈系统架构
软件架构原则浅析
软件 架构 -
浅谈买书好还是看PDF文档好?
&n
浅谈 买书好 还是看PDF文档好 -
浅谈Linux系统平均负载
前言每次发现系统变慢时,我们通常做的第一
数据 运行时间 系统对