我们处于一种糟糕的境地,因为过去的工作人员对关键业务系统所做的定制文档很少。对我们的ERP软件的Crystal Reports,数据库实体和专有配置/编程文件进行了许多更改。
当前文档通常读取如下内容:
该程序在开具发票之前运行。已知错误:无。
安装软件X后运行此程序。
更改了此报告中的以下字段:(未解释如何或为什么)
我们的IT部门很小,就ERP软件而言,大多数工作都集中在一个人上(现在就是我),所以这里没有其他人知道我们所做的一切。IT和会计部门了解点点滴滴(有时很有帮助),但这还不够。
另一个问题是我们的会计部门似乎认为我们有据可查。的确,我们保留了很多错误记录,但很少有解释(如果有的话)解决这些问题的方法。我们有数百篇论文解释错误,但是解释更改的文档(如上所示)几乎没有用。
当我不知道所做的全部工作时,如何记录过去的更改?我可以先记录一下我们所做的更改:文件,数据库表等等,这些是系统正常运行所必需的。我还可以记录我们做的 ; 运行报表时,为什么要告诉人们使用X报表/程序。但是当这些定制的东西之一出现问题时,我总是回到正题。
我如何主动为自己和他人记录这些内容?
rst
和sphinx
用于保持写文档接近代码。