文檔習慣之格式篇 用文檔逼瘋一個人的五種辦法

1 前言

大疆是個特別酷,特別有工程師文化的公司。去年看了大疆的動畫片《RoboMaster》,激動不已,更讓我增加了對大疆的好感。爲什麼講文檔習慣要提到大疆呢?最近在虎嗅看到一篇大疆的報道《大疆走下神壇》,文章雖然主要是分析大疆的現狀和未來思路,但本能手還是從大篇幅中抓住了重點。

一位大疆內部人士稱,汪滔(大疆CEO)的研發體系堪稱國內效率最高,在技術研發上,他建立了一套規則。一位從大疆離職的研發人員向全天候科技證實,汪滔的研發習慣非常好,技術文檔寫得可以當教科書,他會把技術需求分門別類排好,並且把每個流程從哪個環節去調取都列清楚,“有這種研發習慣的人很難不成功”。

成功總得有一些必要條件,文檔習慣就是其中最重要的一個。開發者們可能是僅次於文字工作者之外,需要寫最多文字的羣體了。所以在開發者中強調文檔習慣是特別有必要的。

之前我已經分享過幾篇文檔習慣的心得,側重於文字的表達上,文檔思路上。

麥肯錫教給我的寫作武器:如何講好一句話

如何講好一句話,最主要的是主語謂語要清晰。

麥肯錫教給我的寫作武器:連接詞是文章通順的靈魂

運用邏輯連接詞可以信息之間的關係明瞭,減輕接收者的負擔,更容易向接收者傳達意思。

文檔啊,最重要的還是層次感

金字塔結構就是用一種見樹又見林的方式來呈現出內容框架,我認爲是文檔寫作最重要的一點。表面上是文檔結構,其實背後更多的是對內容的邏輯思考。


如果說文檔思路是靈魂,文字是肉體,那麼文檔格式則是衣服。最近遇到了幾件事情,促使我想分享下對於文檔格式部分的一些想法。

2 起因

小能手前段時間負責了消防國標協議的修改,使其拓展支持 LoRa、LoRaWAN 類設備。在這份協議上還修改了其他同事沒關注到諸多字體、表格格式問題,完善了標題書籤等等。

最近其他同事更新了協議,內容上是沒什麼問題,就是格式上有一點細節沒注意。比如下面這個地方,文檔默認的字體是宋體五號,接下來的第二點採用了另外三種不同的字體。

我們部門裏的小夥伴,最近在更新一份對外的協議上,也出現了一點字體格式的問題。

我們都會出現這樣的情況,時間忙,項目緊,複製粘貼,所以忽略了這些細節的處理。我有時候也會不小心忘記。其實大家只是需要有人提醒一下,稍微注意下,以後估計都會避免這樣的問題了。

本能手由於強迫症,很想讓每份文檔都乾乾淨淨。每次都自己去改文檔,那是不可能的。

所以我決定,留下來 寫下來!

3 用文檔逼瘋一個人的五種辦法

小兄弟,我看你骨骼驚奇,我這剛好有一本祕籍,殺人於無形,慢慢說給你。

3.1 文檔框架

第一條 大殺器 - 千萬要隱藏住文檔結構

是的,這條最厲害。丟一個幾十頁的文檔過去,一定不要帶書籤,最好目錄也不要帶。就是要讓他讀不下去,他肯定會覺得是自己能力不行,而不會說我們文檔寫的差,因爲大部分文檔都這個德行。

文檔結構這種靈魂性的東西,一定不要顯露出來,讓對方去花時間琢磨,在無聲無息中奠定我們的主導地位。千萬不要讓對方看到本能手寫的那篇筆記《文檔啊,最重要的還是層次感》。

第二條 文檔結構圖不統一

這個辦法殺傷力也還可以,一定要故意丟掉一些標題,或者把一些正文轉爲標題。從這些細節上讓對方難受,不積跬步無以至千里,不積小錯無以磨死對方。

一定不要告訴對方,在 word 的樣式中可以修改爲 “標題x” 樣式就可以實現這樣的效果了。

3.2 文檔排版

第三條 巧妙地用空白來混淆我們的意圖

通常人們會通過文檔裏的空白,來對段落意思做邏輯分割。意思相近的段落聚攏,相互獨立的段落分開,可以使用空行,或者用分割線等等。

所以我們一定要巧妙地利用空白來折磨對方。當然,不僅僅是空行了,行間距也是悄無聲息的殺手鐗。

像下面這樣規範的做法,就沒有什麼殺傷力了。

這在代碼習慣裏也分享過,尤其是臥底在敵對公司裏的開發者們,一定要善於利用空白哦。沒事多來幾個空行,特別不要讓其他人在一個屏幕裏完整看完函數。或者把意思相差較大的函數偏偏聚攏在一起,嘿嘿,神不知鬼不覺。

第四條 縮進時也可以抖下機靈

殺死那些強迫症,分分鐘的事兒。

3.3 文檔字體

第五條 字體混用

逼瘋一個人,還有一個特別重要的辦法。我們可以從別的文檔上覆制過來,特別是 WEB 頁面,這樣原本的字體格式也都複製過來了。

這就是個不錯的例子,就是由於 WEB 字體複製引入的多種字體格式。

這樣做的話,閱讀者總覺得文檔不夠規範,但是他又覺察不出到底是哪出了問題。千萬不要通過“清除格式”來讓字體統一,我們便可以又一次逼瘋一個人。

4 總結

好了,這便是本能手這個關於文檔編寫格式的分享,利用文檔逼瘋一個人的五種辦法,神不知鬼不覺。

希望廣大臥底在敵對公司的朋友們勤加練習,如果成功把公司搞破產了,記得回來感謝下本能手。


作者其他精彩文章:


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章