TC周报:从微软docs新站看TC发展趋势

 

从微软docs新站看TC发展趋势;tcworld2016上海站PPT分享;oTMS上海招聘初级TW。...



大家好,本周TC周报内容包括:

  1. 从微软docs新站看TC发展趋势
  2. tcworld 2016 上海站PPT分享
  3. oTMS上海招聘初级TW
1
从微软docs新站看TC发展趋势

微软在5月3日发布了新文档站点的预览版(docs.microsoft.com)。该网站目前只有Enterprise Mobility相关产品的文档,随着新站的完善,未来可能会有更多的产品文档迁移到新站点。(微软的TechNet和MSDN站点已经服役超过10年了,新站点也继承了不少原来的功能。)

TC沪联小编认为微软的这个文档新站做得挺不错的,值得我们好好研究一下。之所以认为它不错,是因为它更现代,符合很多TC的发展趋势,更重要的是,新站点以用户为中心,非常强调用户体验

下面TC沪联小编就和大家一起来分析分析docs.microsoft.com,看看它都体现了哪些技术传播的发展趋势吧。

用户反馈和用户互动

技术文档是用来帮用户解决问题的,那么我们提供的信息是不是真的能够帮助用户,或者是有什么不足,如果能够直接倾听用户的声音是最好不过了。

TC沪联小编认为微软的文档新站就将用户反馈和用户互动做得很好。TW可以在文章里直接看到用户对文档的反馈,并和用户互动。

在每一篇文章,用户可以选中一个段落,一句话,甚至是一个词,然后添加sidenote,十分方便和直观。作者或其他用户可以对你的sidenote进行回复。
此外,用户也可以通过点击页面右侧的COMMENTS按钮或是在页面底部发表对整篇文章的评论或提出问题,与文章作者和其他用户互动。
当评论被回复时,系统会根据用户的设置,给用户发送提醒邮件。
另外,用户还可以在网站上对文档是否有用进行匿名评价。这类反馈会发送到系统后台,不会在前台界面显示。
用户直接参与文档编写

这个厉害了,TC沪联上次线下活动的时候也讨论到,由用户来为其他用户写文档,也可能是TC的发展趋势之一。

有时候用户可能比TW还要更了解产品,懂得其他用户需要什么帮助信息,并且这些用户也愿意分享他们的知识。通过鼓励用户参与文档编写,一方面有助于提高文档质量,另一方面则可以提高用户对文档和产品的参与度,有利于促进用户社区的发展,增加用户对产品的粘度。

现在这个微软新站就提供了让用户编辑文档的功能。新站上的文档源文件是GitHub项目里的markdown文件,用户只要注册一个GitHub帐号,会使用markdown语言,就可以编辑文档并提交变更请求。

TW需要做的就是对用户提交的内容进行验证,确保用户提交的内容在技术和语言上都符合要求。(TW应该不会失业吧,哈哈~)

作为用户,当你想要修改某篇文章时,只需要点击页面右侧的EDIT按钮,就会跳转至GitHub的源文件页面。
GitHub页面:
文档内容变更后,参与文档改动的用户就会成为文章的contributor:
目前开放的可被用户编辑的产品文档:
技术文档快速接入社交媒体

所有的用户都在使用社交类软件,他们随时都可能需要将技术信息分享给其他人。

微软的文档新站,也可以让用户方便快速地将技术文档里的信息分享给其他人

用户可以通过页面右侧的SHARE按钮分享整篇文章:
也可以通过选中段落内容后显示的快捷按钮来在社交媒体分享文章内容:
响应式设计,多为移动终端考虑

随着平板电脑和大屏幕智能手机的流行,用户花在这些移动终端上的时间也越来越多。他们很可能需要在移动设备上阅读技术文档。

微软的文档新站,也顺应了这一趋势,为移动设备做了考虑。

首先,网站本身是基于响应式设计的,也就是会根据阅读设备的不同,自动调整显示的内容和格式,以便用户更好地进行阅读。
另外,就像许多手机阅读app提供夜间阅读模式一样,微软文档新站也提供了Light和Dark两种阅读模式,其中的Dark模式更适合夜间阅读。(你懂的,工程师都要经常加夜班。。。)
清晰的内容组织和导航

新站点还在内容组织和导航上下了功夫,技术内容被很有条理地组织在一起,从而让用户能够更好地学习这些技术内容。

每个产品的文档都有一个首页,上面会列出该产品文档的组织架构及关键topics。
每个topic页面,上方有breadcrumb导航,而左侧有产品文档全目录,显示当前topic在文档库中的位置。另外,如果文章内有子标题(H2元素),在文章正文开始前,还会有一个子标题目录
改进页面的可读性

为了给用户提供更好的可读性,微软文档新站在基于对用户阅读行为研究的基础上,做了两个事情:

  1. 为正文主体内容的宽度设定一个固定的最大值,这样页面的文字内容就不会因为更大的显示器而变得太宽。研究显示,当一个段落的宽度过大时,读者在需要换行继续阅读时,往往不那么容易,有时需要付出额外的努力来确认自己接下来应该读哪一行。TC沪联小编大致看了一下,微软新站点目前采用的是大约730 px的最大宽度,每行大约能容纳100个英文字母
  2. 导航区域和正文字体变大。许多用户反馈微软文档以前的字体太小,需要通过浏览器Zoom In页面才能更好地阅读。


之前的TechNet:
新的文档站点:
显示预计阅读时间和文章更新时间

为了让用户对阅读文章需要的时间有所预期,每篇文章里加入了预计需要的阅读时间。有了这个时间做参考,用户就可以根据自己的情况决定是不是现在就读这篇文章。

另外,每篇文章还加入了更新时间,用户可以很容易地了解到文章的新鲜程度。
控制页面长度,提供PDF输出功能

在网页上,如果一篇文章越长,用户读完这篇文章的可能性就越低。微软文档新站也知道这一点,因此文档在新站里的一个改进就是将以前很长的单篇文章拆成几篇文章(几个topics或steps),然后将这几个页面关联起来,并提供导航。
另外,对于想要把所有内容放在一起,并且进行离线阅读的用户需求,微软新站也将提供相应功能。用户可以将页面内容组合起来,然后生成可以离线阅读的PDF文档。(注:该功能还在开发中,在目前的预览版中还没有实现。)

TC沪联小编认为,能够让用户将网站内容按需组合起来成并生成PDF是一个非常好的功能。小编之前在基于wiki的产品帮助文档里曾经看到过这个功能,期待看到微软会把这个功能做成什么样子。我们知道,当TW建议将传统PDF文档转成在线文档时,总会有人提出还有客户在使用PDF,不能消灭PDF。好的,那就让我们向微软学习,在以online为主导的同时,想办法满足那部分PDF用户

给微软文档新站的一个建议

TC沪联小编注意到,在微软文档新站上,无论是在文档主页,还是在单篇文章的页面中,都没有看到搜索功能,用户只能通过导航、目录和关联主题来寻找信息。

搜索功能被广泛使用的今天,还有什么理由不在文档站点加入搜索功能呢?何况微软还有自己强大的Bing可以利用呢。
2
tcworld 2016 上海站PPT分享

大家之前问到的tcworld 2016 上海站演讲的PPT文件,现在终于开放下载了。想要了解本次会议具体内容的同学,赶紧去下载吧:

http://conferences.tekom.de/index.php?id=2326
3


oTMS上海招聘初级TW
oTMS(上海先烁信息科技有限公司)上海招聘初级文档工程师。

oTMS是领先的一站式运输服务平台,基于国内首创的社区型“SaaS平台+移动APP”的模式,连接运输网络,带给客户全新的一站式物流管理服务体验。

官网:http://www.otms.com/

JD和联系方式如下:

职位:技术文档工程师

地点:上海

职责:

* 编写产品相关手册;

* 维护在线文档;

* 与其他团队合作以满足Sprint排期的需求;

* 文档开发初稿编写与更新;

* 检视文档以确保内容正确,保证文档质量。

任职要求:

* 技术文档工程师相关工作经验一年以上

* 熟悉常见的文档开发工具

* 能够独立工作,团队协作意识好

* 物流行业工作经验,具有SaaS产品或大型软件平台工作经验者优先

* 快速学习能力和自我激励

* 良好的表达能力与写作功底

* 有能力开展文档测试和验证工作

* 责任心强,易于沟通和交流

联系方式:

请发邮件至 lisa.wang@otms.cn 或 QQ (706859100)私聊,Lisa会尽快和您联系。
 

TC沪联

分享行业文章,互通信息资讯

开展课题研究,促进合作交流

投稿邮箱:

ShanghaiTC@technicalwriter.cn

微信号:Shanghai-TC


    关注 TC沪联


微信扫一扫关注公众号

0 个评论

要回复文章请先登录注册