新闻资讯
400-775-3365
传真:+86-21-52388011
邮箱:infor@imgchina.com.cn
您的位置:主页 > 新闻资讯 > 顾问茶座 >
优秀SAP开发文档撰写技巧
发布时间:2016-06-13 作者:imgchina 浏览:
就我所知,任何一个开发人员要做的最后一件事情就是写开发文档。一般来说开发文档都是项目交付物的重要组成部分,如果文档低于验收标准,轻则返工重写,重则客户拒绝付款。所以如何写好SAP实施中的开发文档是一个事关重大的工作,而ABAP程序员们却经常为此苦恼,我觉得很有必要说道说道。
开发文档不是蓝图,不是设计文档,它的重点是关于技术的、关于实现的,但也不仅仅是一些伪代码。应当包含“程序为什么设计”、“主要功能点是什么”、“目标是什么”、“程序的编码思想思路是什么”等内容。没有一个结构化的、连贯的程序主要逻辑说明,用户或者文档阅读者是看不出你如何使用数据或组织数据的。所以我们必须将数据和代码演变为信息管理,实现需求设计所要求功能。

7个要点罗列

模板和标准 最为关键的是在撰写文档前和客户约定好开发文档模板以及各部分验收标准,取得事半功倍的效果。使用一个良好的模板范本和客户详细沟通,逐步改进达成一致,而不是匆匆忙忙按自己的理解编写完所有开发文档,而被客户验收时一脚踢出,打回重写,事倍功半。

客户中心 技术文档是作为交付物而存在的,因此一定是面向客户的。要让客户知道程序提供了什么,是否达成了预期,程序运行的结果,以及你是如何达成预期结果的。不要让用户读完不理解你做了什么,那样就必须返工重做了。

不要仅描述乐观路径 在有程序重大的异常分支处理存在时,一定要在开发文档里体现出来,满足程序对乐观路径和悲观路径的全覆盖。

可视化 一个用户友好的文档应该是可视化的,对程序的一些复杂情况如接口相关、数据库表的交叉引用、流程图、屏幕编程等最好使用图片、图表或者附件等方式,更清晰完美的展现技术内核。

WORD 风格 利用WORD工具的目录或者文档地图等功能,让用户可以快速浏览开发文档。当然还包括使用统一的字体、对齐、缩进、小标题、LOGO等有用的小技巧。

及时更新  当重要变更发生时,一定要及时更新文档。在SAP的项目里,开发文档一般是最后撰写,这个时候程序相对已经稳定,改动会较少,但也不要对这点视而不见。

结构化文档  在一个大项目里,通常会包含若干个程序,那么文档本身也需要管理。通常应该按照模块或者程序类型放置在不同的文件夹路径里,另外避免给文档命名如’XX_023_DS_1.0’,应该用有意义的名称。

以上经验都是我经过了多个项目和客户的考验,得到了积极正面响应,这样做出来的文档是面向客户的、可读性好的、包含了技术信息的。看起来好像需要花费更多时间,但在实际操作时,其实只需要花很少的时间和精力。
返回
二维码
Copyright © 2016 IMGChina 版权所有   ICP备案编号: 沪ICP备11014812号-1 

为了更好的为您服务,网站可能读取您的COOKIE信息,如您不允许读取可直接关闭网站即可,谢谢!