期末论文

期末论文是个人作业,所有同学均需要完成,大家可以选择将课上内容整理为教程或者做一篇跟本学期内容相关的小型研究,具体如下:

工具教程

本学期涉及的工具有:

  1. Sphinx
  2. Jekyll
  3. DITA
  4. oXygen
  5. MadCap
  6. easydita
  7. Guided Tour
  8. Help Desk
  9. 可用性测试工具

除上述内容外,大家可以结合课上内容选择感兴趣的知识点进行编译,知识点如下:

  1. 极简主义(结合上课内容,汇编课上提供的两本极简文档的英文教材)
  2. 用户信息行为
  3. API文档解决方案
  4. 技术传播工程师应懂的人因工程知识(编译 Human Factors for Technical Communicators )
  5. 软件文档代码化(Doc as Code)
  6. 同源开发和模块化文档 (编译 Single Sourcing: Building Modular Documentation )
  7. iiRDS
  8. Lightweight DITA
  9. 可用性测试方法
  10. Bootstrap for Technical Writers
  11. Github for Technical Writers

没有指定书目的,需要自行找资料编译。

研究选题

大家也可以选择感兴趣的话题做一些深入研究,下方是一些可能的选题:

  1. 中国用户获取帮助信息的行为研究。探索用户获得帮助的倾向性、顺序、使用技术信息的行为(扫描,跳读,速度等)。
  2. 中国企业对技术写作人员的要求。收集若干条招聘启事,分类,标注,汇总分析
  3. 中国企业技术传播意识调查。抽样调查中国企业对技术传播的意识。
  4. 知名中国企业文档合规性研究。挑选若干在海外经营的企业,对照IEC82079等标准进行合规性检查,并给出分析报告
  5. 中西软件产品帮助手段对比研究。中西方各找前100名的软件公司,分析对比帮助手段的不同。
  6. 技术信息的渐进式呈现及其实现。
  7. 嵌入式用户帮助研究。
  8. Storytelling 在用户帮助文档中的应用
  9. 创新型用户帮助综述(AR/VR,基于模拟,物联网,聊天机器人等新颖智能用户帮助)

作业要求

  1. 需要使用rst语言写作
  2. 教程篇幅至少20页(输出为PDF后)
  3. 研究至少10页(输出为PDF后),需要符合学术规范
  4. 提交时间 6月19日 22:00
  5. 每位同学均需在6月20日下午报告自己的研究或教程
  6. 提交方式:CATTP

补充说明

  1. 优秀的教程将编入课程讲义,未来将有机会出版
  2. 优秀的研究论文,会跟作业讨论,可以合作发布期刊论文
  3. 希望大家认真完成,不清楚的可以在群里讨论。