Swoole 船新版本文档发布了,是兄弟就砍我!

2020年2月19日 245点热度 0人点赞 0条评论

一、前言


Swoole的文档一直被人所吐槽,虽然内容很丰富,但看起来很费力,更新也稍有些不足,所以这次识沃科技专门组织了人力和资源重新打造这一船新版本的文档,让人眼前一亮,下面我们一起来看看吧


二、文档原则


使用直白的语言,尽量少介绍 Swoole 底层技术细节和一些底层的概念,底层的后续可以维护一个专门的 hack 章节


写文档时要转变思维,以小白的角度去审视别人能不能看得懂

后续出现功能改动的时候一定要把所有涉及的地方都修改一遍,不能只修改一个地方

每个功能模块必须要有一个完整示例;



三、文档组织形式


旧版本的文档,在文档组织形式上,左侧菜单直接堆积了Swoole各模块的名称,对于老手来讲,上来很容易直接找到对应的模块直接查相关的文档,但新手一上来会比较懵逼,新的文档组织形式相对更结构化,按照下图的思路进行归类,更加友好且有组织

图片

左侧的菜单也是循序渐进,示例丰富

图片

四、UI界面

文档界面更清爽、且色彩分明

图片

关键词突出,一目了然

图片

重点提醒,特殊标识

五、支持全文搜索

图片

点击结果,PAJAX方式直接跳转,体验友好

六、移动端支持友好

下面是我手机查看的两张截图

查看文档内容:

图片

点击菜单:

图片

手机端打开,操作方便,体验流畅,美观

七、总结

这次文档的升级诚意满满,体验有一个质的提升,希望大家在文档上有何问题,可以随时反馈给Swoole团队,查看原文,可直达新版文档体验。

----------线-----------


PHP(phpfamily) PHPer




稿稿


稿


shenzhe163@gmail.com


 桶哥   

图片


35650Swoole 船新版本文档发布了,是兄弟就砍我!

这个人很懒,什么都没留下

文章评论