《软件文档写作》教学现状及对策

朱红军

中图分类号：G642.0 文献标识码：A 文章编号：1002-7661（2015）01-0009-02

一、课程现状

随着软件复杂程序的不断增加，人们对软件产品开发过程的系统化、规范化和标准化的要求也越来越严格。为保证软件开发、维护等环节的有效管理以及方便软件技术人员之间进行技术交流，软件生命周期的每一个阶段都需要编制不同类型的文档。软件文档和计算机程序及数据共同构成能完成特定功能的计算机软件，对软件项目，特别是大型软件项目来说，没有文档的软件不能称其为软件。

软件文档在早期没有固定的内容和形式，直到1988年我国才出台了计算机软件产品开发文件编制指南GB/T8567-1988，对文件的主要内容和形式做出了规定。在2006年对GB/T8567-1988标准进行了修改，制定了新的计算机软件产品开发文件编制指南GB 8567-2006。软件文档写作技能作为软件文档工程师的核心技能，在IT行业越来越得到重视。为此，许多大学如麻省大学、浙江大学、南京大学等早已将软件文档写作作为软件类专业的专业课程，重庆邮电大学也已将《软件文档写作》纳入软件工程学院软件工程专业的专业课程。由此可见，《软件文档写作》作为一门新课程，在IT行业技术需求的推动下正在逐步得到规范和重视。

二、教学现状

《软件文档写作》应该基于软件工程的思想，根据软件产品开发过程中各类软件文档编制的实际需要和软件文档编制的国家标准，系统地讲授计算机软件开发各个阶段文档写作的步骤、内容、方法、工具、特点、要求以及撰写与沟通技巧。《软件文档写作》作为一门新课程，在教育教学过程中还存在诸多问题，主要表现在以下几点。

1.教材质量不高

目前可供参考的软件技术文档写作相关的教材不多，主要有清华大学出版社出版的《软件文档》、电子工业出版社出版的《软件文档写作教程》及高等教育出版社出版的《软件文档编写》等。这些教材或内容陈旧（仍然根据GB/T8567-1988旧标准编写），或只注重文档写作格式或写作工具的介绍，缺乏符合最新标准的文档撰写内容诠释和实例。因而，这样照搬这些内容将导致理论与实际的脱节，授课内容不具有可操作性。

2.教学内容枯燥

目前现有的可供参考的软件技术文档写作相关的教材都普遍存在重理论、轻实践的问题。大多教材仅叙述了软件技术文档的格式和要求，而缺乏对文档内容的确定过程和写作技能技巧的介绍，因而，教学内容枯燥，缺乏实用性。

3.教学资源匮乏

《软件文档写作》是一门相对较新的课程，目前配套的资料（如PPT、案例和范文）都非常少，特别是符合最新国家标准GB8567-2006的资料，这就增加了教师备课和学生学习的难度。

4.教学方法陈旧

由于教学资源匮乏，在教学过程中教师普遍采用基于认识学习理论的讲授法教学。该方法造成学生对知识的掌握停留在初级认知水平上，难以对其产生广泛、灵活的迁移，实现对知识的加工和创造性应用。

5.教学效率低下

由于教学内容枯燥和教学方法陈旧，学生理解困难，学习兴趣不高，从而使学生的综合素质和能力得不到培养和提高，学生在工作中不能灵活应用所学知识解决实际问题，难以胜任文档工程师的工作。

三、教学对策

在教学方法上，顾蓬蓬和施庆平等老师分别在软件文档写作课程中探索了案例教学法。国外对软件文档写作采用的标准与我国稍不同，但主流的教学方法依然是案例教学法。该方法能使学生在课堂学习中具有明确的学习目的，从而提高了学生学习的主观能动性和课堂参与意识。

在教育心理学领域中，建构主义理论认为学习过程不是学习者被动接受知识，而是积极主动建构知识的过程。基于此理论，建构主义者提出了情景教学法，它强调把所学的知识置于真实的任务情境中，在教师的主导下让学生在主动完成任务的过程中学会知识，并以此过程为载体全面培养提高学生的素质和能力。情境教学法目前已经在教学中得到广泛应用研究。实践表明：在模拟真实的任务情境中，学生通过角色扮演充分调动了的主观能力性。积极运用学习资源和意义建构、自主探索和协作学习的过程有利于学生学习、创造和协作能力的培养。

在模拟真实的任务情境中，学生通过角色扮演融入情景，可以感受真实现场的氛围，深刻体会软件文档写作的诸要素，便于理解软件产品开发文件编制指南中规定的各部分内容的必要性，因而，情境教学法是《软件文档写作》教学过程中最有效的教学方法。