ERP定制的文档

时间:2015-02-27 08:33:58

标签: documentation enterprise documentation-generation erp

我想知道,如果你有一个好的指导,或者是否有工具来记录ERP系统中的自定义。就我而言,我正在研究Infor SyteLine ERP 8,但每个ERP都可能出现这个问题。

ERP自定义文档的难点在于,智能和数据分布很广:

  • SyteLine ERP:
    • 表单脚本(VB.NET,C#)
    • 表格活动
    • 全局事件的事件处理程序
    • 后台任务
  • 数据库SQL Server:
    • 存储过程
    • 功能
    • 用户定义的数据类型
  • Microsoft Report Builder:
    • 报告模板

作为示例:创建报告涉及表单脚本,表单事件,后台任务,存储过程,然后是报告。

您是否有经验或想法如何在一个地方记录所有内容?我有时也希望对表单事件进行评论,但在SyteLine中甚至不能直接表达事件。或者有没有办法如何结合来自不同地方的文件?例如,我们是否记录每个自定义或添加的数据库功能。但即便如此,也很难记录SQL Server代理任务。

非常感谢您的投入!

1 个答案:

答案 0 :(得分:1)

恕我直言,首先,必须提供标准版的完整文档。

随着项目的进行,我们可能会进行一些自定义,我们将其记录为"更改日志"。

是的,例如,很难将文档维护为单个维度 - 当您更改/添加数据库字段时,您需要' DB更改日志&#39 ;; - 当您更改/形成活动时,您需要注意可能'使用案例'图。 - 当您在报告中隐藏某些信息时,您需要在其他地方记下它。 -etc。

作为一名ERP开发人员,我总是得到一份混合文档,其中一些似乎与之无关,但实际上却是如此。然后我现在设法通过丰富的列表获得文档,但保持维度,例如:

- 一个Excel列表:      -

  • 设置-Module / SubModule -Form of Module / SubModule -Feature in 一般用户&用户组&许可证 - 数据类别 - 授权 用户对模块/子模块的使用 - 用户对数据的授权 类别 - 批准流程 - 报告 - 表格&用于报告的字段 -Table&用于表单的字段

- 每张表中每个模块的处理流列表的Excel。

我认为必须涵盖:

  • 让其他人轻松了解它是如何运作的,
  • 让其他人轻松找到原始功能,
  • 这些数据的其他类型'可以,
  • 此功能的其他类别'与此模块相关的是 可用及其状态和时间表,
  • 此表单更改对其他用户的影响

需要尽可能简单地维护大量的列表。

您目前是如何处理文档的?