AntConc说明书改造¶
date: | 2018-05-16 |
---|
项目作业要求:¶
AntConc是一款语言学分析的重要免费工具,其帮助文档为PDF,文档存在诸多值得改进的地方,本次课程综合项目要求对现有文档进行改造,使其达到现代主流技术文档水准。
软件及其帮助地址,http://www.laurenceanthony.net/software/antconc/
全班同学5人一组,共分4组,自由分组,由班长和助教协调。
任务一、非结构化转结构化¶
该任务需要大家能将AntConc的帮助文档转为DITA的结构,便于后续的内容复用和升级
- 识别官方文档的信息类型。按照DITA的信息分类方式,使用颜色进行信息标记。例如使用红色标记概念信息、蓝色标记步骤信息(颜色自定义) 。
- 转写为DITA topic。按照DITA的Topic结构要求,将上方识别的不同信息类型转为相应的DITA Topic。
- 将dita文档发布为PDF(PDF需要有索引)和HTML。
第一次提交内容¶
- 做好颜色标记的AntConc PDF 帮助文档
- 所有的dita topics(打成文件包)
- 提交时间:2018年5月29日 20:00
- 提交至CATTP平台
任务二、改进帮助文档¶
该任务需要大家脱离原来的帮助文档,能够站在一个没有限制的角度,从零开始设计AntConc的帮助文档,写作的时候可以使用CCMS进行协同写作,助教给大家申请了easyDITA的两个月试用,足够大家完成作业了。
大概步骤:
- 需求分析。需要做用户调研,弄清楚用户常见的任务。
- 信息设计。确定信息呈现的方式,手段,语言风格。
- 信息开发。根据上述思考,进行实际写作(可以复用第一步的topic)
- 信息评价。按照ISO 9126-4标准,对文档执行可用测试,对比改进后的文档是否比原文档有更高的可用性。
说明:
- 设计风格不限。极简文档、情感化文档、渐进式文档、嵌入式文档等等各种风格均可。
- 工具与技术不限。写作时可用DITA,M-DITA,reST,Markdown;协同时可以ccms,github,svn,webdav均可。
- 评价指标不限,自行确定。
参考资料:
- 极简文档的Greyfiti任务分析法
- SeSAM 方法
- PI-Class (Wolfgang)
- DITA Style Guide
第二次提交¶
- 所有工程文件
- 项目报告PPT,6月5日 22:00
- 同时需要在6月6日课堂导航各组报告自己的研究工作