一、前言
Swoole的文档一直被人所吐槽,虽然内容很丰富,但看起来很费力,更新也稍有些不足,所以这次识沃科技专门组织了人力和资源重新打造这一船新版本的文档,让人眼前一亮,下面我们一起来看看吧
二、文档原则
使用直白的语言,尽量少介绍 Swoole 底层技术细节和一些底层的概念,底层的后续可以维护一个专门的 hack 章节
写文档时要转变思维,以小白的角度去审视别人能不能看得懂
后续出现功能改动的时候一定要把所有涉及的地方都修改一遍,不能只修改一个地方
每个功能模块必须要有一个完整示例;
三、文档组织形式
旧版本的文档,在文档组织形式上,左侧菜单直接堆积了Swoole各模块的名称,对于老手来讲,上来很容易直接找到对应的模块直接查相关的文档,但新手一上来会比较懵逼,新的文档组织形式相对更结构化,按照下图的思路进行归类,更加友好且有组织
左侧的菜单也是循序渐进,示例丰富
四、UI界面
文档界面更清爽、且色彩分明
关键词突出,一目了然
重点提醒,特殊标识
五、支持全文搜索
点击结果,PAJAX方式直接跳转,体验友好
六、移动端支持友好
下面是我手机查看的两张截图
查看文档内容:
点击菜单:
手机端打开,操作方便,体验流畅,美观
七、总结
这次文档的升级诚意满满,体验有一个质的提升,希望大家在文档上有何问题,可以随时反馈给Swoole团队,查看原文,可直达新版文档体验。
----------伟大的分割线-----------
PHP饭米粒(phpfamily) 由一群靠谱的人建立,愿为PHPer带来一些值得细细品味的精神食粮!
饭米粒只发原创或授权发表的文章,不转载网上的文章
所发的文章,均可找到原作者进行沟通。
也希望各位多多打赏(算作稿费给文章作者),更希望大家多多投稿。
投稿请联系:
shenzhe163@gmail.com
本文由 桶哥 授权 饭米粒 发布,转载请注明本来源信息和以下的二维码(长按可识别二维码关注)
文章评论