【学习总结】Text for the web (MMoS 2)

The web has become the foremost--and sometimes only--method for communicating with users. As a result, having a web content strategy is critical to content teams.

                                                            --Digested from Content for the web (MMoS)

目前公司文档就是web-based且发布周期是two weeks。遇到Doc Feedback,随时可以fix bugs or make improvements。看到这一章时,我的感触挺多的,与我以前的写作方法基本吻合。我记录一些要点,强化记忆。

详细内容参见:https://docs.microsoft.com/en-us/style-guide/scannable-content/

Make text scannable

Put first things first

Be brief, be bold, be clear

Include navigation within long documents

Establish patterns in content

Give paragraphs room—and keep them short

Organize text into discrete components to support scanning. This section describes some of the methods you can use:

Headings

Lists

Pull quotes

Sidebars

Tables

How you write is equally important to scanning.

目前CEM文档的问题

* Long web content on a page (Discouraging and daunting for readers)

Cause: The left navigation bar contains two-level TOC. Each web page contains a one-level mini TOC.

Competitor: the layouts of AWS and Microsoft e-doc are a three- or four-level TOC in the navigation bar, which helps reduce the long web content on a page.

*  Table design is not friendly (not scannable)

Cause: The in-born issues with markdown syntax (such as text in a cell can't be broken into paragraphs), the poor design (such as the heavy table header, the gray background for rows). 

* Part is not task-based writing. Not put first things first

* The Mini-TOC design is easily mistaken for an ad.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 我是黑夜里大雨纷飞的人啊 1 “又到一年六月,有人笑有人哭,有人欢乐有人忧愁,有人惊喜有人失落,有的觉得收获满满有...
    陌忘宇阅读 12,732评论 28 53
  • 首先介绍下自己的背景: 我11年左右入市到现在,也差不多有4年时间,看过一些关于股票投资的书籍,对于巴菲特等股神的...
    瞎投资阅读 11,052评论 3 8
  • ![Flask](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAW...
    极客学院Wiki阅读 12,149评论 0 3
  • 不知不觉易趣客已经在路上走了快一年了,感觉也该让更多朋友认识知道易趣客,所以就谢了这篇简介,已做创业记事。 易趣客...
    Physher阅读 8,718评论 1 2