太誇張了!華爲的這篇技術文檔,竟然寫了5217頁……

2024-01-08 18:10:43    編輯: robot
導讀 今天是周末,小棗君按照慣例在公司加班。 突然,我看到粉絲群裏,有小夥伴發了一條消息: 一看到這條消息,我就來了勁—— 什么鬼文檔,竟然會有五千多頁?我們平時的文檔,最多也就幾百頁啊…… 爲了眼見爲實...

今天是周末,小棗君按照慣例在公司加班。

突然,我看到粉絲群裏,有小夥伴發了一條消息:

一看到這條消息,我就來了勁——

什么鬼文檔,竟然會有五千多頁?我們平時的文檔,最多也就幾百頁啊……

爲了眼見爲實,我趕緊私信小夥伴,要來了這份文檔。

發來的時候,文檔大小果然非同一般,達到了124.9M:

收了半天,總算下載下來。然後打开:

哦吼,果然,不多不少,一共5217頁。

這是一篇華爲光傳輸設備OSN1800的硬件描述文檔,主要介紹產品及單板的型號、外觀、參數等信息

看了一下目錄。僅僅是目錄,就有84頁……

文檔正文,一共有33章,小節不計其數……

我又統計一下字數,一共大約181萬漢字,或者366萬個字符(含空格)

這是啥概念?紅樓夢才70萬字,聖經(基督教舊約)150萬字,大家可以對比一下。

我仔細瀏覽了一下這份文檔。文檔介紹了很多的單板、業務,以及光模塊。型號確實非常繁雜,再加上內容基本上以表格和圖片形式爲主所以篇幅極爲龐大。

部分頁面展示:

小棗君也當過好多年的文檔經理,深知文檔工作的重要性,以及把這項工作做好的難度。

這么說吧——這篇5217頁的超級文檔,真的是刷新了我的認知。

我個人有以下感受:

從產品的角度來看,通信技術經過這么多年的發展,確實變得非常復雜產品類型多,單板型號多,技術參數也多,想要逐一紹到位就需要海量的文檔篇幅。

文檔的篇幅越來越大,不僅給廠商的文檔編寫帶來了巨大的挑战,也給用戶帶來了不小的壓力。

文檔團隊的工作難度,會持續攀升。我們打开的是PDF版本,試想一下,使用文檔开發工具進行編寫的時候,肯定涉及到多人團隊的協作。幾千頁的文檔,能夠做到不出錯,很不容易。更別談要保證文檔的可讀性。

華爲的這篇文檔,格式規範,內容全面。我挑了一部分細看,寫得很有幹貨,堪稱質量上乘。行業一貫都將華爲文檔視爲標杆,確實有一定道理。

不過我還是覺得,當文檔內容過於龐大的時候,也許可以通過分冊的形式,進行分解。不然的話,對於客戶閱讀和使用,確實會帶來很大的不便。

這還只是產品手冊的其中一篇。整套文檔,一般包括幾十本手冊。客戶打开這種文檔,估計都會有很大的心理壓力。

大塊頭的文檔,基本上是作爲手冊查詢使用,如果真的是拿來一頁一頁學習,肯定會直接崩潰。5千多頁的文檔,如果打印出來,估計也能佔滿整個書架。

好啦,最後我再問問大家,你們遇到過比這篇更龐大的文檔嗎?大家覺得,行業裏還有哪些公司的文檔寫的好?哪些寫得爛?

歡迎在評論區留言!



標題:太誇張了!華爲的這篇技術文檔,竟然寫了5217頁……

地址:https://www.utechfun.com/post/315093.html

鄭重聲明:本文版權歸原作者所有,轉載文章僅為傳播信息之目的,不構成任何投資建議,如有侵權行為,請第一時間聯絡我們修改或刪除,多謝。

猜你喜歡