SCI论文（www.lunwensci.com）:
摘 要：快速发展的现代信息技术与不断深化的高等教育教学改革深度融合应用。高校在大力开展教学信息化平台建设与应用中，容易忽略对操作文档外的其他相关文档的重要性认识及其建设，而这些相关文档可以为平台的持续性建设与维护管理提供重要支持和保障。通过结合教学信息化平台建设与应用管理的实践，以高校用户的视角， 研究分析了文档体系的组成内容、每类文档的编制意义及其编制的具体方法，为高校同步开展教学信息化平台文档体系的构建提供实践方法参考。
关键词：教学管理；信息平台；文档编制
本文引用格式：郑前进，等 . 用户视域下教学信息化平台文档体系构建 [J]. 教育现代化 ,2020,7(34):1-3.
Construction of Document System of Teaching Information Platform from the Perspective of Users
ZHENG Qian-jin, ZHU Chen-wei
(Office of Academic Affairs of China University of Mining & Technology, Beijing)
Abstract: The rapid development of modern information technology and the deepening of higher education teaching reform are deeply integrated. In the construction and application of teaching information platform, it is easy to ignore the recognition and construction of the importance of other related documents, which can provide important support and guarantee for the sustainable construction and maintenance management of the platform. Based on the practice of teaching information platform construction and application management, and from the perspective of university users, this paper studies and analyzes the content of the document system, the significance of each type of document preparation and the specific methods of preparation, so as to provide practical method reference for the synchronous construction of teaching information platform document system in universities.
Key words: Teaching management; Information platform; Documentation
一 引言
近年来，现代书院制、大类培养、国际化培养、本研一体化培养等高等教育教学改革纵深推进，移动技术、大数据、云计算、人工智能等现代信息技术快速发展。为适应教学改革与教学工作日益发展需求，切实提高教学管理和服务的信息化水平，不断增强教育教学治理能力 [1-3]，高校掀起了新一轮本科教学信息化平台的建设浪潮。
二 问题的提出
本科教学工作是一项庞大复杂的系统性工程，决定了教学信息化平台建设和管理工作的艰巨性和复杂性，主要体现：一是在内容组成上，包括培养方案、排课、选课、成绩、学籍等十多个业务子系统，涵盖教学运行、教学建设、教学评优和教学服务等教学工作各环节，每个业务子系统又包含几个或十几个功能模块，几百个参数设置和功能操作按钮。二是在数据结构上，设计有千余张数据表，万余个数据字段，逻辑关系复杂。三是在运行形式上， 包括基于 B/S（客户机和服务器）框架的客户端程序运行和基于 C/S( 浏览器和服务器 ) 框架的网页形式运行 [4-6]，高校中有采用单一形式，也有两种形式兼用。四是在支持载体上，实现传统电脑端应用是基本要求，基于 APP 程序或微信小程序形式的手机端移动应用也成为普遍要求。五是在迭代更新上，教学改革不断深入，人才培养方案持续改进，一般四年修订一次，每修订一次平台就需要进行适应性升级、改造、优化或重构。
软件产品是程序、数据及其相关文档的完整集合 [7-9]，文档是软件产品的重要组成部分，在开发人员、维护人员、管理人员、用户与计算机之间起到桥梁作用 [10]。但是软件企业往往只注重内部开发文档的编写 , 而忽视了用户文档 [11]，用户也往往只注重功能与界面的开发建设要求，忽略了相应文档的建设重要性。综合教学平台具有前述庞大复杂等特点，更需要高校重视并主动从用户的角度建立和完善文档体系，为平台的功能应用、维护管理和再次开发建设提供支持和保障。反之，将不利于甚至无法正常开展这些工作。
三 文档的组成
以用户的视角，信息平台的可持续全生命周期包括建设、运行和再建设过程，其中建设过程指软件工程学上软件的定义和开发两个时期，即需求与设计（概要和详细）、编码与测试、部署与交付等 [12]； 运行过程指应用实现的功能开展教学工作，以及针对应用过程中出现的各种问题进行处理即维护管理； 再建设过程指应需求更新与变化对现有平台进行升级改造、功能拓展或重构新建，该过程遵循建设过程的一般过程。
建设过程中主要编制有需求文档、设计文档、测试文档、技术文档（数据库文档）等，运行过程中主要编制有操作文档和维护文档。从益于高校开展教学信息化建设、应用和管理的角度，需要编制形成的文档体系主要包括技术文档（数据库文档）、操作文档和维护文档，如图 1 所示。
图 1 信息平台文档体系组成结构
其中技术文档亦指数据库文档，属于基础性文档，是平台运行维护和再建设的核心资料；操作文档是各项功能具体操作的说明集，是平台使用者必不可少的辅助资料；维护文档是处理运行过程中各类问题的有效方法集，是平台运维人员的备查资料。
高校开展教学管理信息化建设常见有三种模式： 高校自主开发建设模式、软件供应商提供标准版教学管理信息系统模式、高校和软件供应商联合建设模式 [13]。不管高校实施哪种模式，需要编制的文档体系相同，每类文档编制的意义相通，编制的方法相近。
四 文档的编制意义及其方法
（一） 数据库文档
数据库文档是对数据表及其字段详细描述形成的完整集，数据库特指由二维关系数据表组成的集合体，数据表是字段（属性）的物理构成，字段是由长度、类型、允许 NULL 值、是否关键字等特征标识组成，表之间通过关键字（码键）建立关联关系 [14]。教学工作中产生数以万计的数据按表的结构以行的形式存储。通过数据库文档能直观了解数据表的基本组成结构，透视教学数据的存储位置、形式和流动关系。平台日常维护管理工作主要是集中处理数据类问题，唯一有效的方法就是查询研究数据库数据，纠错性增删改数据。平台再建设时，无论是委托原开发方或新开发方，实施过程中一个重要环节是结合新需求研究清楚现有数据库数据结构和逻辑关系。
数据库文档由开发方在建设过程中编制，应要求在平台交付时提供。表名称和字段名称是文档编制的最基本要求，两种信息一般是英文或拼音表示， 即使有命名的标准和规则，信息缺失时也不利于及时有效理解其释义，如发现有缺失及时要求补充完善，除外其他信息即使没有完全编制，也可以通过使用的 SQL SERVER 或其他数据库平台打开查知。由于运维工作的核心是围绕数据库开展数据研究分析与纠错处理，具有较强的专业性和技术性，没有计算机相关专业背景人员很难掌握和应用，有些高校把运维事项直接列入开发合同，委托开发方负责， 这种模式下，存在开发方不主动提供数据库文档。针对类似情况，需要遵循一个原则，即无论采用何种运维模式（自行或委托），何种合同形式（独立或合并），尽量在开发合同中明确提出携同提供数据库文档的要求。
（二） 操作文档
高效应用平台开展业务工作是平台建设的目的， 正确应用是高效的前提，熟练应用是高效的保障。面对各信息平台，特别是涉及功能模块多、触发操作按钮多、逻辑关系比较复杂的平台，熟练、准确应用是平台正常运行和推进工作顺利开展的基本要求，也是极大减少运维工作量的理想愿景。因为误操作可能会引起数据错误和程序运行错误，研究造成这些错误的原因和修复这些错误花费的时间和精力有时是巨大的，甚至严重影响工作的正常进度。唯有为各类用户编制内容详尽、通俗易懂、查阅便捷的操作文档，指导用户正确使用平台，并在应用实践中提高操作技能水平，才能更好地发挥信息平台服务教学工作的效能。
同购买电器或设备随同提供使用说明书一样， 由开发方在平台交付时提供操作文档是基本要求。即使如此，尽量在合同中予以明确提出提供的具体要求。开发方编制的操作文档，一般是以功能模块为单位顺序编制，使用者可以结合自己的阅读习惯和应用经验，按照实际业务流程自行调整或重新编写。对那些描述过于专业化或不直观的地方，用直白易懂的词句更新描述；对那些描述简单、释义不全面的地方补充描述；对那些容易发生误操作和周期性易忘操作，采用图文并茂形式及时详细描述， 并重点标注予以提醒。
（三） 维护文档
在应用实践中长期磨合，是平台稳定运行的必经过程，磨合过程中出现的各种问题，可分类归纳为功能性和数据性两方面，其中功能性问题是由于在需求、设计或开发阶段考虑不周全，出现操作无响应或功能不完整，这类问题只影响工作进度，通过修改更新程序解决了就不会再出现；数据性问题是由于功能缺陷或操作失误（这种行为很有可能重复发生），产生冗余性、删减性、错误性等不正确数据，这类问题的发生不仅影响了工作进度，重要的是改变了工作内容，有些不正确数据不易被发现长期“潜伏”“正确”存在。维护人员及时有效协助或独立研究解决这些问题的同时，做好详细记录以便后续备查尤为重要。
维护文档主要由用户编制，其核心三要素是编制的内容、方法和时间。从编制内容上，要把发生的情况、分析的原因、处理的方法等描述清楚；从编制方法上，要尽量采用图文并茂方式描述以增强可读性，重复性现象重点标识提醒；从编制时间上， 要在问题出现并解决后，及时按内容依方法详细记录，定期分类整理。维护文档编制时可依照问题类型有侧重点编制，功能性问题由开发方解决，编制时以流水账形式把三要素记录清楚即可；数据性问题编制时除按三要素把不正确本源数据发现的始终， 潜在关联数据的挖掘方法，具体原因的分析过程和数据纠正的方法等详尽描述，还应从整体解决思路层面进行经验性小结。
五 结语
文档是信息平台不可或缺的组成部分，对其建设、应用与管理具有重要作用，并应在建设、应用和管理过程中同步建设完成。高校应进一步系统认识和重视文档编制工作，结合实际并按照一般建设方法， 加强对数据库文档、操作文档和维护文档等重要文档的编制和建立，形成规范和完备的文档体系备查。
参考文献
[1] 教育部 . 教育信息化“十三五”规划：教技 [2016]2 号 [Z].2016. [2]
[2]教育部 . 教育信息化 2.0 行动计划：教技 [2018]6 号 [Z].2018.
[3]新华社 . 中共中央国务院印发《中国教育现代化 2035》[J]. 人民教育 ,2019(05):7-10.
[4]吴浩 , 孙毅超 , 柳淑学 . 基于 B/S 模式的实验室设备管理系统的设计与实现 [J]. 实验技术与管理，2019,36(07):270-274.
[5]李梅川 , 杨颖 , 李兴国 , 等 . 基于 C/S 与 B/S 混合模式的高校实验室建设与维护管理信息系统开发 [J]. 实验技术与管理， 2007,24(01):79-82,86.
[6]骆慧 , 勇汤进 . 融合 C/S 和 B/S 优势的应用程序开发方法 [J]. 电子设计工程 ,2017,25(10):14-17,21.
[7]刘 炜 . 浅 析 文 档 在 软 件 项 目 开 发 中 的 作 用 [J]. 价 值 工程 ,2010,(26):151.
[8]施庆平 . 面向案例驱动的《软件文档写作》课程改革与实践 [J]. 现代计算机 ,2013,(31):46-47.
[9]刘海燕 , 王晓池 , 张立杰 , 等 . 面向案例驱动的软件文档撰写能力培养研 [J]. 中国教育技术装备 ,2017,(18):92-94.
[10]肖刚 , 古辉 , 程振波 , 等 . 实用软件文档写作 [M]. 北京 : 清华大学出版社 ,2005.
[11] 康锋. 重视用户文档的质量[J]. 中国科技信息,2007,(18):173,177.
[12]张海藩 , 吕云翔 . 软件工程（第 4 版）[M]. 北京 : 人民邮电出版社 ,2013.
[13]黄波 , 朱昌平 , 黄健元 , 等 . 基于用户视角的教学管理信息化建设绩效评价 - 以教学管理信息系统建设为例 [J]. 中国电化教育 ,2018,(380):69-74.
[14]王珊 , 萨师煊 . 数据库系统概论（第 5 版）[M]. 北京 : 高等教育出版社 ,2014.
关注SCI论文创作发表，寻求SCI论文修改润色、SCI论文代发表等服务支撑，请锁定SCI论文网！
文章出自SCI论文网转载请注明出处：https://www.lunwensci.com/jiaoyulunwen/31985.html
