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

  • 2020 年 2 月 25 日
  • 筆記

一、前言

Swoole的文檔一直被人所吐槽,雖然內容很豐富,但看起來很費力,更新也稍有些不足,所以這次識沃科技專門組織了人力和資源重新打造這一船新版本的文檔,讓人眼前一亮,下面我們一起來看看吧

二、文檔原則

使用直白的語言,盡量少介紹 Swoole 底層技術細節和一些底層的概念,底層的後續可以維護一個專門的 hack 章節

寫文檔時要轉變思維,以小白的角度去審視別人能不能看得懂

後續出現功能改動的時候一定要把所有涉及的地方都修改一遍,不能只修改一個地方

每個功能模組必須要有一個完整示例;

三、文檔組織形式

舊版本的文檔,在文檔組織形式上,左側菜單直接堆積了Swoole各模組的名稱,對於老手來講,上來很容易直接找到對應的模組直接查相關的文檔,但新手一上來會比較懵逼,新的文檔組織形式相對更結構化,按照下圖的思路進行歸類,更加友好且有組織

左側的菜單也是循序漸進,示例豐富

四、UI介面

文檔介面更清爽、且色彩分明

關鍵詞突出,一目了然

重點提醒,特殊標識 五、支援全文搜索

點擊結果,PAJAX方式直接跳轉,體驗友好 六、移動端支援友好

下面是我手機查看的兩張截圖 查看文檔內容:

點擊菜單:

手機端打開,操作方便,體驗流暢,美觀 七、總結

這次文檔的升級誠意滿滿,體驗有一個質的提升,希望大家在文檔上有何問題,可以隨時回饋給Swoole團隊,查看原文,可直達新版文檔體驗。

----------偉大的分割線-----------

PHP飯米粒(phpfamily) 由一群靠譜的人建立,願為PHPer帶來一些值得細細品味的精神食糧!

飯米粒只發原創或授權發表的文章,不轉載網上的文章

所發的文章,均可找到原作者進行溝通。

也希望各位多多打賞(算作稿費給文章作者),更希望大家多多投稿。

投稿請聯繫:

[email protected]

本文由 桶哥 授權 飯米粒 發布,轉載請註明本來源資訊和以下的二維碼(長按可識別二維碼關注

Tags: