“软件文档编写”教学

【摘 要】本文从实际出发，结合自身体会，针对在教学中遇到的普遍性问题，提出一些对于“软件文档编写”课程的教学建议。

【关键词】高职 “软件文档编写” 教学

【中图分类号】G642 【文献标识码】A 【文章编号】1674-4810（2013）17-0066-02

一份关于计算机人才需求的调研报告中提到：写作能力也是用人单位很重视的一种重要技能。有不少毕业生在工作中的应用写作能力有待于提高，往往是心里有话，却无法清楚透彻地表达，缺乏清晰的思路、算法和逻辑过程。同样，毕业生普遍认为计算机专业课程设置中文科课程的比例太少了，应加强应用性、科技性写作的训练。

一 教学中遇到的问题

从调研报告了解到，文档写作应成为高职高专计算机技术类相关专业教学的重点。有许多院校已经把“软件文档编写”设为必修课程，但效果并不佳。本人通过几年的教学工作，总结了以下几点在这门课程教学中遇到的问题。

1.学生不重视文档写作

一提到文档写作，学生的第一印象是一篇篇比较枯燥的文章，容易产生厌学心理。对于多数高职计算机专业的学生而言，他们认为专业技能的高低是将来就业的关键，至于文档写好写坏无关紧要。

2.学生文字表达能力不强

多数高职学生普遍存在语文水平不高、文字表达能力较弱的现象。有些学生甚至表示最讨厌写作文，所以也不喜欢写文档。

3.学生生搬硬套，无法灵活掌握

有些学生在写文档时会直接套用模板或抄袭，有些学生不顾内容，文档填满就算是完成任务了。这样导致文档不但缺乏逻辑性，而且也毫无真实性。

4.学生基础课程的知识不扎实

文档写作和软件工程的生命周期是息息相关的，开发的每个过程都会产生相应的文档，这就要求学生能对软件开发的整体过程有个初步的概念。学生在没有掌握好相关学科知识的情况下，很难写出较好的文档。

二 改进措施

针对以上问题，总结自身的教学体会，本人认为可以通过以下几点来改进这门课程的教学。

1.提高学生对文档的认识

第一，从正面介绍文档的重要性。在初次授课时，让学生打开任意一个招聘网站，搜索有关软件文档的岗位信息，介绍相关的职位描述和任职要求。学生会很惊讶地发现，原来写文档也是一个发展和就业的方向。

第二，介绍一些大型公司软件文档的应用方式，如软件文档是大型国际化软件的组成部分，包括用户手册、联机帮助、市场宣传资料等。大型软件外包服务公司内部都开发了软件内容管理系统（CMS），设有专门的写作团队，为软件开发商提供多种形式的文档内容写作、排版、测试等服务。内容写作可能是网页形式，也可能是多媒体课件、需要印刷的产品文档、包装材料和市场宣传材料等。通过提供专业的内容写作服务，使得内容与应用程序有效集成，增强用户的体验，也降低了软件开发商的成本。

第三，从反面谈谈文档的重要性。如《IT经理世界》刊登了这样一篇文章《下班后你的公司还值多少钱》。文章开头讲了这样一个小故事：一位软件公司的老总感慨地说：“做软件公司，最痛苦的事情是下班之后，你发现自己的公司除了几台电脑外，几乎什么也没有了。因为公司最值钱的资产都在每个程序员的脑子里，这些人一旦离开，公司的资产就等于零。”通过此例引导学生懂得，文档能体现设计思想和研究成果，将不可见的软件开发进程转换成可见的文字资料。

2.加强学生的表达能力

表达能力的培养不是一朝一夕的事情，优秀的文档案例必不可少。但要强调的是文档写作不是写作文，不要求有很好的文采，但是描述一定要清晰、明确，一定要符合项目实际情况，而且尽量采用专业术语以及图形来辅助，如大量使用面向对象的UML（统一建模语言）。清晰的图示能高效说明问题，图文并茂的文档才有更好的可读性。

3.案例教学+团队协作

这门课程的实践性较强，必须结合实际的软件开发案例，采用理论和实践相结合的案例教学法来进行教学。在具体教学过程中，应轻形式、重实效，课堂上以一套完整的实际项目文档来教学，另外布置一个项目的文档作为作业或学期作品，确保学生亲自动手完成的时间。学生可以组队完成项目作品，对软件进行准确需求分析和详细设计，并正确采用相应文档来表达。学期末通过项目评审的形式进行作品评比，制造再学习的机会，让学生互相找缺点，取长补短。

4.培养学生良好的写作习惯

第一，培养写作的规范性。如在文档中选取的表达方式要统一，字体、标注、说明、命名规则等都要形成统一的风格。文档的模板根据项目的大小采用相关的国家或国际标准。

第二，培养写作的实时性。在实际的项目中，需求的变更是常有的事，那么文档也要根据变更的内容进行相应修改。建议可以模拟项目的变更，让学生进行文档版本的控制，

如设置1.0版本、2.0版本等。

5.加强学科间的交叉互动

这门课程涉及许多相关学科的知识，如软件工程、软件项目管理、需求分析与设计、UML统一建模语言等课程，所以在指导学生写作时，需要注意学科间的交叉互动与知识的拓展。

三 总结

随着计算机技术的不断发展，教师只有与时俱进，不断改善教学内容和教学方法，适应课程的需要，才能在教学中取得更好的教学效果。

参考文献

[1]国际化软件开发与外包测试集成[EB/OL].http：//tech.

/m/2008-04-26/200804261604358.shtml

[2]潘孝铭、幸明海.软件文档编写[M].北京：高等教育出版社，2004