用戶手冊

用戶手冊

記得剛參加工作后,就接觸到了電信大型機房里面設備的源代碼,而這些代碼是由一個個組件(component)組成的,就像積木一樣,每個積木(組件)都有一份用戶手冊,這個手冊面對的用戶不是機房的管理員,而是搭積木的開發人員,因此手冊的質量好壞直接影響了積木能否搭的好。組件都是用C語言編寫的,而手冊呢,大家可能見過微軟的msdn的,在那個時候,需要一張光盤的容量,后來貌似是好幾張,反正非常詳細,我們的組件手冊就是類似的東東,里面對于組件有個基本的架構介紹,使用場景分析,然后是提供的功能/特性介紹,接著就是這些功能/特性的API詳細描述,最后是一些DEMO的示例代碼。一份好的用戶手冊,能夠幫助搭積木的人(二次開發者,架構師,測試工程師等)迅速理解積木(組件)的原理,快速搭建開發。而一份錯誤百出的手冊,足以使機房的機器宕機N次,記得有幾個月公司專門定期派人出差帶在機房守著,半夜兩點重啟機器,為什么呢,因為不重啟,很快就會宕機,而且很難恢復,所以問題沒有被排除查出來之前,就像女人來了大姨媽一樣,每個月總的出差一次。后來查找原因,根源在于用戶手冊API說明錯誤導致誤用后內存泄漏。

這樣的事情算是比較嚴重的了,因為一旦宕機,5分鐘一個城市無法打電話發短信上網,那么電信運營商的損失少則幾千萬,多則上億。其他因為用戶手冊的謬誤或者讀用戶手冊的人的理解錯誤導致的問題就更多了。曾經使用過Source Insight這個軟件,也許你也用過,這個工具是一個閱讀/分析代碼的工具,當然也可以編輯,性能卓越,在沒有atom/sublime text,github等之前,可以說這個工具是讓開發者感覺異常幸福的工具,不但這個工具本身好,你是否看過它的用戶手冊,這個手冊寫的相當的好,既有面對小白用戶的簡要說明,又隱含了宏控制和可定制功能,手冊語言深入淺出。

同樣,atom工具是github開發的開源編輯器工具,工具好用用過便知,關鍵除了一般意義上的用戶手冊之外,專門出了Atom Flight Manual,易讀性強,只不過大部分人可能讀不完整,如果真的通讀一遍了,那么對于編輯器,就會有和之前完全不同的思考角度,甚至它們錄制了有意思的引導視頻

Atom Flight Manual開篇就是

Why Atom?

There are a lot of text editors out there; why should you spend your time learning about and using Atom?

Editors like Sublime and TextMate offer convenience but only limited extensibility. On the other end of the spectrum, Emacs and Vim offer extreme flexibility, but they aren't very approachable and can only be customized with special-purpose scripting languages.

We think we can do better.Our goal is a zero-compromise combination of hackability and usability: an editor that will be welcoming to an elementary school student on their first day learning to code, but also a tool they won't outgrow as they develop into seasoned hackers.

Atom和Source insight有個共同點,既適合于初學者使用,容易上手,又能夠滿足用起來后,逐步探索深度用法的群體。

當然關于Atom,我認為有一個點很有必要改進,就是它的插件,即packages,特別是每個package的使用手冊,一個字,爛。

說到package,就會讓人想起了nodejs,npm,看看這倆的API手冊或者用戶手冊吧,相當不錯,例子豐富,當然,也許這是許多人用起來的緣故吧。node的用戶手冊不用說了,有node的組織搞定。npm上面的package,用戶量大的包自然也沒有問題,話說大部分也是使用最常用的,所以相比之下,node的package部分用戶手冊還不錯。

而關于用戶手冊,這個神器你不可錯過。

DASH

Dash is an API Documentation Browser and Code Snippet Manager. Dash stores snippets of code and instantly searches offline documentation sets for 150+ APIs (for a full list, see below). You can even generate your own docsets or request docsets to be included.

除了各種語言/平臺的用戶手冊外,他還有cheat sheets(不理解,到GitHub上面搜搜),cheat sheets還有ascii表(想當初可以打印出來貼在辦公位前方的)和emoji等等(驚喜多多),甚至你還可以自己定義cheatsheet和用戶手冊,這對于提供各種SDK的網站/平臺來說,多么好的工具啊。

不過有點可惜,只有mac平臺和Ios平臺有。

你看過的優秀用戶手冊是什么手冊?(不限IT領域)理由?

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,527評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,687評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,640評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,957評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,682評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,011評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,009評論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,183評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,714評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,435評論 3 359
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,665評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,148評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,838評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,251評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,588評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,379評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,627評論 2 380

推薦閱讀更多精彩內容