日志统计窗是dp2circulation前端主菜单“功能”下的第一个统计窗。
这个统计窗涉及到以下手册内容:
1) 在用户手册中要介绍这个窗口的基本操作方法。但这里不要讲太复杂的细节,让用户能进行日常操作,理解一些基本概念就可以了;
2) 因为同属于“统计窗”类型的几个窗口,具有很多共性,集中介绍这些共性,能节省用户手册中介绍这些窗口的章节的篇幅。所以希望在编写手册的过程中,注意抽取这些共性并集中介绍。在具体的每个窗口的介绍中,要处理好引用这些共性的文字和独立介绍的关系 --- 既便于阅读、也节省手册篇幅。
3) 日志统计窗所统计的对象是应用服务器每天不断自动产生的日志(文件中的)记录。
需要在参考手册中详细介绍应用服务器的日志是怎么回事,存储在什么目录下,文件名的命名规则是什么...,等等。对于系统管理员来说,这些知识要系统,要精密,要具有参考价值。然后,在参考手册中要介绍日志文件的XML结构,这种介绍要深入细致,目的是让系统管理员能理解其结构并完全自主开发出利用日志记录的模块。
实际上在前端针对统计窗进行二次开发的时候,主要的任务就是理解各种日志记录的格式,然后能够操纵这些日志记录,统计出想要的数据结果。
这里也涉及到C#脚本代码对XML记录的操作课题。二次开发者除了应当掌握.NET Framework中XmlDocument类和相关类的用法外,参考手册还应当系统全面地介绍DigitalPlatform.Xml中的DomUtil类的函数,这是数字平台公司为了方便操作XmlDom而扩展出来的一些实用函数。这里说的XmlDocument类的操作,在参考手册中用到的时候简单提到即可,不做详细讲解。因为这些知识可以从Microsoft的网站查到,也是一个二次开发者的基本功,参考手册没有必要详细介绍这些知识。
4) 我们需要一同把日志统计窗现有的统计方案的C#脚本代码进行剖析,理解它们。然后在参考手册中一个一个加以比较详细地介绍,让系统管理员能理解这些脚本代码。如果以后因为维护更新的缘故修改了任何统计方案,那么在公司网站上更新统计方案本身的同时,也要同步修改手册中的内容。
5) 根据实际情况,我指定一些课题,我们一起来编写几个新的日志统计窗的统计方案,以达到检验知识掌握程度,考察手册内容是否完满的目的。这些课题覆盖面要广,要关注到用户的具体需求,也就是说统计方案对用户来说要有用,另外也对现有的标配统计方案形成补充。争取能达到这个目标。
~~~
后面,我将一点一点细化上述设想,补充各种材料,让设想的过程能顺利进行下去。