Mobirise

第六次技术传播沙龙活动

主题:极简主义与结构化写作


一号通知

(演讲嘉宾招募)

背景:

技术传播沙龙活动由北京大学软件与微电子学院发起,已经举办五次,第六次活动预计将于2017年4月份在北大举行,具体日程将待演讲嘉宾确定后尽快通知。


演讲嘉宾招募

本期沙龙研讨主题为“极简主义与结构化写作”。结构化写作方法应用广泛,写出的文档完整规范,但有时并不好用;而极简主义方法写出的文档通常并不具备传统意义上的文档结构,但是符合用户行为模式。两种方法目前都有不少应用,各自均有不少优缺点。


本次沙龙活动,将由北大软微学院的师生分享学界对这两种方法论的讨论研究,同时也非常期待业内有实际应用的企业分享宝贵的实践经验。如您愿意成为演讲嘉宾,请填写下方报名表单报名。


后续沙龙选题

北京大学软件与微电子学院开设的《技术传播方法》课程主要讲授技术传播行业中常见的方法论、模型和原理等。后续会结合课程内容,举办更多专业性研讨。

极简主义

始于上世纪90年代的极简文档 (minimalist instruction)是技术传播领域发展的里程碑事件。极简主义在信息爆炸的时代显得极为吸引眼球,同时这一概念在建筑、设计、文学、音乐和语言学中也有诸多应用。less is more 的理念可以说深入人心,但是技术文档中的极简主义与其他领域所说的极简主义不完全一样。当前关于极简文档有诸多误区。


极简并不意味着惜墨如金

Minimalism 指的是 minimize 对用户信息行为的影响,而非minimize 文本。极简主义认为用户并不喜欢直接看文档,而是凭借自己的先验知识直接尝试使用产品,遇到问题后再去查阅说明书。当前流行的文档常常需要用户首先阅读说明书,然后再使用产品,因此说明书对用户的使用习惯是有影响的。因此极简文档需要尽量minimize 对用户的影响,去除用户不喜欢的介绍、简介和总结等信息,直接提供真实案例让用户上手试验。

按照此理念设计的极简文档常常较短,这里篇幅较短是该方法的结果,而非原因。


极简并不只是指导原则

早期的极简主义确实只是一些指导原则,但是经过几十年的发展,极简主义已经成了一套相对完善的方法论,可以指导实际的文档写作。如Every Page is Page One方法,Greyfiti Mehtod等可实际应用的方法论。


极简文档特点

1. 帮助用户快速开始使用产品

2. 使用真实的任务

3. 信息模块化,允许用户从任何顺序阅读

4. 开发用户的先验知识

5. 便于识别错误,并从错误中恢复

6. 鼓励用户积极学习,鼓励思辨,提高理解能力


极简主义的原则与启发

Principle 1. Choose an action-oriented approach

Heuristic 1.1 Provide an immediate opportunity to act

Heuristic 1.2 Encourage and support exploration and innovation

Heuristic 1.3 Respect the integrity of the user’s activity


Principle 2. Anchor the tool in the task domain

Heuristic 2.1 Select or design instructional activities that are real tasks

Heuristic 2.2 The components of the instruction should reflect the task structure


Principle 3. Support Error Recognition and Recovery

Heuristic 3.1 Prevent mistakes whenever possible

Heuristic 3.2 Provide error information when actions are error prone or when correction is difficult

Heuristic 3.3 Provide error information that supports detection, diagnosis, and recovery

Heuristic 3.4 Provide on-the-spot error information



结构化写作

提起结构化写作,常常会联想到一系列规则、某种工具、特殊的标准或者是XML,DITA或DocBook。结构化写作是宽泛的领域,包括多种“方法”、“最佳实践”、“工具”和“技术”。我们在说结构化写作的结构时,通常有两层含义,一种是修辞结构,另外一种是结构化数据。


修辞结构 (Rhetorical Structure)

修辞结构指形式化定义了”内容“、”顺序“和”呈现形式“,以便信息能更好的使用和理解。结构化写作并不高深,生活中也非常常见。例如硕士论文写作便是一种常见的结构化写作,其通常结构都要包括:

1. 封面 2. 目录   3. 摘要 4.前言与背景 5. 文献调查 6. 研究方法 7. 研究结果 8. 讨论与分析 9. 总结或结论 10. 附录 11. 参考文献 12. 致谢 

按照上述结构,可提示学生将大的写作任务分解成小的部分,从没有头绪变得可以分步去完成,最终写完论文。按照此方法写完的论文,结构完整,符合研究范式,也便于导师和评审老师阅读和反馈相关信息。


技术写作也有自己的结构写作的例子也非常多,例如API文档,Information Mapping等。


结构化数据(Strucutred Data)

结构化数据便于机器读取。例如使用XML创建的数据结构,可方便地由计算机进行处理,同时也便于与其他程序交换数据。”修辞结构“通常转换成结构化数据进行形式化表达。例如论文可用LaTex,技术文档可用DITA,DocBook等结构化方式实现。 需要注意的是,随着互联网技术的发展,很多非XML的结构化数据结构逐渐变多,如JSON,rST等。


结构化写作的优点:

  1. 提升内容质量。修辞结构常常是多年经验的总结,或者团队商议的结果。结构化写作可以确保内容完整、一致和易使用。
  2. 可为写作人员提供引导。根据结构,写作人员可轻松写出高质量内容,大大降低了难度。
  3. 分工写作。结构化可引导不同的写作人员写出一致的内容,便于分工完成大型项目。
  4. 内容复用。因为结构一致,内容复用变得更为容易。



演讲嘉宾报名

报名截止时间:2017年3月15日