SAP License:优秀SAP开发文档撰写技巧

就我所知,任何一个开发人员要做的最后一件事情就是写开发文档。一般来说开发文档都是项目交付物的重要组成部分,如果文档低于验收标准,轻则返工重写,重则客户拒绝付款。所以如何写好SAP实施中的开发文档是一个事关重大的工作,而ABAP程序员们却经常为此苦恼,我觉得很有必要说道说道。

SAP License:优秀SAP开发文档撰写技巧 图1

开发文档不是蓝图,不是设计文档,它的重点是关于技术的、关于实现的,但也不仅仅是一些伪代码。应当包含“程序为什么设计”、“主要功能点是什么”、“目标是什么”、“程序的编码思想思路是什么”等内容。没有一个结构化的、连贯的程序主要逻辑说明,用户或者文档阅读者是看不出你如何使用数据或组织数据的。所以我们必须将数据和代码演变为信息管理,实现需求设计所要求功能。

7个要点罗列

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

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

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

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

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

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

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

以上经验都是我经过了多个项目和客户的考验,得到了积极正面响应,这样做出来的文档是面向客户的、可读性好的、包含了技术信息的。看起来好像需要花费更多时间,但在实际操作时,其实只需要花很少的时间和精力。

SAP相关产品:

SAP GRC权限合规检查系统(简称AMS-R系统)是SAP ERP应用企业进行权限合规检查、违规数据抓取和IT审计的理想工具。

AMS-V SAP License 资产优化管理系统产品:是应用于SAP系统权限风险控制及注册用户账号管理为目标的SAP软件资产精益化管理方案。

SAP 日志堡垒机安全管理系统(简称AMS-L系统)是一款面向SAP ERP 系统的网络安全管理工具,提供基于SAP系统用户业务行为的常态化监管,是对SAP现有日志体系的有效增强管理。

SAP 运维管理平台系统(简称AMS-Ops)旨在确保企业SAP应用系统健康、稳定运行的基础上,持续性的改进、优化,从而满足其业务发展需要的企业级SAP系统运维管理服务。

AMS SAP 商超订单统一管理系统以商超平台订单集中管理为核心,系统支持多平台、多店铺、全渠道系统采购订单、验收单、结算单等业务单据的统一管理;商超订单统一管理系统支持与 SAP ERP 系统的无缝衔接,在SAP ERP系统中自动生成销售订单、外向交货单,核对验收单、结算单等 SD 模块业务操作,有效的简化企业商超订单管理工作流程,保证订单数据处理的统一、准确、高效,实现跨系统、组织的协同管理,提升企业营销效率。

关于赛锐信息

河南赛锐信息科技有限公司(简称“赛锐信息”)是一家致力于SAP ERP系统应用的服务商,公司立足打造基于AMS产品套件的企业信息化解决方案,结合前沿技术追求最佳用户体验、企业信息化优秀解决方案和企业级产品应用的供应商。公司自主研发的AMS系列软件产品是国内首个用于SAP权限风险识别的增强系统,也是同行业用户精益化管理解决方案中最优的解决方案,作为用户管理、风险规避和信息审计的辅助工具,其有助于规范企业的管理行为,帮助建立合规的管控流程,有效提高企业IT资产投资回报率;AMS系列产品在各项技术指标上拥有完全的、独立的领先优势,可以满足市场竞争、技术许可和标准制定等方面的需要。

作者:SAP权限管理 QQ:2651000673

 

相关新闻

联系我们

联系我们

130-0752-1773

在线咨询:点击这里给我发消息

邮件:info@sapzx.com

工作时间:周一至周五9:00-18:00,节假日正常休息

关注微信
关注微信
分享本页
返回顶部