職業(yè)病發(fā)作,從技術文檔撰寫角度看《得到品控手冊》

今天夜郁,終于通過“得到”微信公眾號什燕,下載到了心心念念的《得到品控手冊》。甫一到手竞端,就迫不及待翻看起來秋冰。

首先,必須要申明我個人是得到的忠實粉絲婶熬,每天幾乎只要耳朵閑著剑勾,都會把時間都花在“得到”上埃撵。

也非常感謝得到為各種長度的碎片化時間和學習提供不同形式和內(nèi)容的選擇。而且這一本手冊對于后續(xù)的人執(zhí)行同樣的操作具有很強的指導作用虽另。后續(xù)的人可以很大程度參考和引用其中的內(nèi)容和思路暂刘。這些我會在后續(xù)陸續(xù)與大家分享。

但是捂刺,出于用戶和忠粉的角度谣拣,再加上職業(yè)病發(fā)作,我還是想先給得到品控手冊挑挑刺族展。畢竟森缠,既然宣稱是品控手冊,至少品質(zhì)上也得能樹個標桿不是仪缸。不過如下都是我個人意見贵涵,僅供大家一樂。

首先恰画,從用戶閱讀便捷性來看宾茂,做得不是特別好。通篇有很多大大小小的章節(jié)構成拴还,將近200頁跨晴,但是能夠跳轉(zhuǎn)的目錄只有如下幾個,沒有下一級目錄片林。

缺少二級目錄

如果我想回看某個章節(jié)端盆,就得用手指拼命往回劃拉。

第二费封,《產(chǎn)品操作手冊》名不副實焕妙。因為實際講的并不是產(chǎn)品的操作,而是產(chǎn)品的制作或運營孝偎。也就是說访敌,這并不是一本operator manual,教用戶如何使用衣盾。而更像是一本生產(chǎn)作業(yè)指導書寺旺,工藝文件,指導內(nèi)容生產(chǎn)者如何生產(chǎn)势决。同時兼?zhèn)淞鞒毯鸵?guī)范的作用阻塑,講述如何進行質(zhì)控。

第三果复,平行的章節(jié)之間架構差異比較大

仍然以《產(chǎn)品操作手冊》舉例陈莽,本章包括若干產(chǎn)品的制作規(guī)范,如“訂閱專欄”,“每天聽本書”走搁。作為平行的章節(jié)按說它們至少應該在大的框架上保持一致独柑,如包含概述,人力&職責私植,操作規(guī)范等等忌栅。到目前看來并非如此,不過也可能是得到自身特色?

如下所示一個大章節(jié)曲稼,與其平行的內(nèi)容都包含1索绪,2,3贫悄。而這里卻直接在主標題(文章標題)下就是2.1瑞驱。

沒有1,沒有2窄坦,直接就有2.1

另外唤反,平行章節(jié)內(nèi)容體量差別太大,顆粒度不均勻嫡丙。有的二級標題下面內(nèi)容多達兩三頁拴袭,有的只有一兩句話读第,顯得頭重腳輕曙博。

第四,沒有采用更為直觀的展現(xiàn)形式

如下的一個逐步遞進的判斷怜瞒,可以用邏輯流程圖直觀展現(xiàn)父泳。

建議使用邏輯流程圖

如下的內(nèi)容則可以選擇表格加流程節(jié)點,列明任務類型吴汪,時間節(jié)點惠窄,責任人,通過條件即可漾橙。

建議使用表格

第五杆融,語言拖沓,標點使用不規(guī)范

多處存在標點不規(guī)范問題霜运,如下:

句末建議使用逗號

第六脾歇,語氣風格問題

通篇很多都在說不該如何做,這在操作手冊中不提倡淘捡。

建議多使用主動句藕各,祈使句,避免使用被動句焦除,否定句激况。

如上例的第四句,“不要騙我”,建議改為“圖文一致乌逐,不做標題黨”竭讳。

此外,還有很多的大長句浙踢,讓讀者難以判斷邏輯關系代咸。

語意不清晰

看了好久,我還是沒看明白成黄,運營需求與交替校稿的關系呐芥。而內(nèi)容需求和錯別字、彈窗又是什么關系奋岁。建議拆分思瘟,不要為了省字表意不清。

第八闻伶,缺少必要的參考信息

文中提到的很多信息滨攻,應該不是得到獨創(chuàng),而是援引法律法規(guī)蓝翰。但是沒有在合適位置注明出處光绕。這一方面不符合寫作規(guī)范,有侵權危險畜份。同時會削減內(nèi)容的可信程度诞帐。一句話,如果是直接從法律法規(guī)中扒拉出來的爆雹,看起來可信度就高多了停蕉。

沒列明具體的參考文獻

湊齊了吉祥的八點,可以安心睡覺了钙态。

我應該算是善意引用慧起,不算是曲解或者修改吧?

最后再次推薦得到APP。

注:來源册倒,《得到品控手冊》蚓挤。

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市驻子,隨后出現(xiàn)的幾起案子灿意,更是在濱河造成了極大的恐慌,老刑警劉巖拴孤,帶你破解...
    沈念sama閱讀 212,029評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件脾歧,死亡現(xiàn)場離奇詭異,居然都是意外死亡演熟,警方通過查閱死者的電腦和手機鞭执,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,395評論 3 385
  • 文/潘曉璐 我一進店門司顿,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人兄纺,你說我怎么就攤上這事大溜。” “怎么了估脆?”我有些...
    開封第一講書人閱讀 157,570評論 0 348
  • 文/不壞的土叔 我叫張陵钦奋,是天一觀的道長。 經(jīng)常有香客問我疙赠,道長付材,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,535評論 1 284
  • 正文 為了忘掉前任圃阳,我火速辦了婚禮厌衔,結果婚禮上,老公的妹妹穿的比我還像新娘捍岳。我一直安慰自己富寿,他們只是感情好,可當我...
    茶點故事閱讀 65,650評論 6 386
  • 文/花漫 我一把揭開白布锣夹。 她就那樣靜靜地躺著页徐,像睡著了一般。 火紅的嫁衣襯著肌膚如雪银萍。 梳的紋絲不亂的頭發(fā)上变勇,一...
    開封第一講書人閱讀 49,850評論 1 290
  • 那天,我揣著相機與錄音砖顷,去河邊找鬼贰锁。 笑死赃梧,一個胖子當著我的面吹牛滤蝠,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播授嘀,決...
    沈念sama閱讀 39,006評論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼物咳,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了蹄皱?” 一聲冷哼從身側(cè)響起览闰,我...
    開封第一講書人閱讀 37,747評論 0 268
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎巷折,沒想到半個月后压鉴,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,207評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡锻拘,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,536評論 2 327
  • 正文 我和宋清朗相戀三年油吭,在試婚紗的時候發(fā)現(xiàn)自己被綠了击蹲。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,683評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡婉宰,死狀恐怖歌豺,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情心包,我是刑警寧澤类咧,帶...
    沈念sama閱讀 34,342評論 4 330
  • 正文 年R本政府宣布,位于F島的核電站蟹腾,受9級特大地震影響痕惋,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜娃殖,卻給世界環(huán)境...
    茶點故事閱讀 39,964評論 3 315
  • 文/蒙蒙 一血巍、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧珊随,春花似錦述寡、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,772評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至衩辟,卻和暖如春螟炫,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背艺晴。 一陣腳步聲響...
    開封第一講書人閱讀 32,004評論 1 266
  • 我被黑心中介騙來泰國打工昼钻, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人封寞。 一個月前我還...
    沈念sama閱讀 46,401評論 2 360
  • 正文 我出身青樓然评,卻偏偏與公主長得像,于是被迫代替她去往敵國和親狈究。 傳聞我的和親對象是個殘疾皇子碗淌,可洞房花燭夜當晚...
    茶點故事閱讀 43,566評論 2 349

推薦閱讀更多精彩內(nèi)容