當前位置: 妍妍網 > 碼農

不要老開會,要學會用文件溝通

2024-06-19碼農

來源:分布式實驗室

👉 歡迎 ,你將獲得: 專屬的計畫實戰 / Java 學習路線 / 一對一提問 / 學習打卡 / 每月贈書

新計畫: 仿小紅書 (微服務架構)正在更新中... 。全棧前後端分離部落格計畫 2.0 版本完結啦, 演示連結 http://116.62.199.48/ 。全程手摸手,後端 + 前端全棧開發,從 0 到 1 講解每個功能點開發步驟,1v1 答疑,直到計畫上線。 目前已更新了287小節,累計45w+字,講解圖:2008張,還在持續爆肝中.. 後續還會上新更多計畫,目標是將Java領域典型的計畫都整一波,如秒殺系統, 線上商城, IM即時通訊,Spring Cloud Alibaba 等等,

  • 文件的重要性

  • 文件第一,會議第二

  • 建立文件優先的文化

  • 不是銀彈

  • 總結

  • 我非常喜歡編寫文件。除了寫程式碼,我認為這是我最喜歡的工作。 文件能為企業帶來巨大的長期價值 ,個人投入編寫文件的時間能夠在公司層面上帶來相當於 100 倍時間的生產力。

    如果你是一位技術總監,文件就是你的秘密武器,你創業公司的無名英雄,那位在產品開發後台默默守護的灰衣騎士。它消除了猜測和重復發明輪子的困擾,像一張黃金門票,能讓新成員迅速融入團隊。這份寶藏地圖將引導新人和老手穿越創業公司流程的迷宮。你的團隊會更快地找到立足之地,成為高效的貢獻者,工作效率超出你的預期,所有這些都源於你決定優先記錄下來的內容。

    不要像這樣

    這裏有一個問題,哪個更好:

    1. 給某人寫封電子信件,打斷他們專註工作的狀態,要求解釋某個軟體的工作原理。

    2. 還是自己尋找所需資訊,並以自己的節奏進行處理。

    提示:第二種方式更好。

    文件的重要性

    讓我們從基礎內容開始。

    想象一下,你是一家初創公司的技術聯合創始人(也許你甚至不需要想象),你正深陷於混亂之中,這是意料之中的事。你每天都在玩打地鼠的遊戲,只是試圖在被拉入另一個問題之前稍作喘息。那麽,你如何擺脫這個惡性迴圈呢?

    答案很簡單 —— 文件化。 我指的不僅僅是維護一個簡單的操作手冊或記錄會議紀要;當然,這些也很重要,但我是指建立一種文化,讓知識不再局限於個人,而是傳播並為整個組織所共享。

    每一件未記錄下來的事情都意味著未來的資源浪費,並且可能成為讓人頭痛的問題,對,就是讓你頭痛問題。我不知道你的情況如何,但我想確保自己沒有任何頭痛問題;這就是為什麽我喜歡構建能夠獨立執行的系統。

    現在想象一下,有多少事情你還沒有記錄下來,那就是你當前可能陷入意想不到問題中的潛在風險。例如,由於一些軟體包的更新,你的持續部署出現了問題。巧合的是,只有來自 X 部門的鮑伯知道如何修復這個問題。但是他整個星期都在度假。

    💡文件編寫減少了頭痛問題,避免影響休假。

    你可以把文件編寫看作是有效創用CC的基石。 在創業初期,當你是唯一的程式設計師,與 CEO 坐在辦公桌前交談就可以簡單地分享資訊和想法。如果出現問題,你可以透過所擁有的知識和手段來修復它。但這種方式很累人,而且你基本上成為了公司發展的瓶頸。如果你去度假 —— 不對,你根本無法去度假,因為如果你休假,一切都會停滯不前。

    隨著創業公司規模的擴大,人員、計畫和復雜性呈指數級增長。知識被困在你的腦海中,溝通變得復雜混亂,結果是人們需要花更多時間追尋你的資訊,而不是真正套用它。

    作為技術創始人,要盡可能將你掌握的每一點知識都寫下來。 這將成為一個普遍的真理源,一個動態的知識庫,捕捉並保留著團隊的智慧。這份智慧能幫助團隊中的每個人解決他們曾一無所知的問題。這樣你也能放心去度假。相信我,你需要這樣做。

    文件第一,會議第二

    既然你知道文件編寫能讓你的生活變得更輕松而不是更困難,那我們來談談時間和效率的問題。

    在創業公司的世界裏,時間是至關重要的資源。每一刻鐘都承載著所做決策、產品構建和市場擴充套件的重要性。而會議則是這種資源最容易被消耗的地方。

    請別誤會,我並不是說所有的會議都是沒用的,但我們必須審慎權衡它們的成本與價值。借用 Bukowski 的一句話,「除非它像火箭一樣自然而然地迸發出來,否則就別去做。」 把這個原則套用到會議上 —— 除非有必要,否則就不要開會。

    頻繁舉行會議的需求是一個更深層次問題的癥狀 —— 缺乏清晰、易於獲取和可靠的文件。 一個有良好文件支持的工作流程不需要長時間的會議來進行討論。 一個有良好文件支持的決策不需要滿屋子的人來理解其原因。一個有良好文件支持的知識庫不需要每當新成員加入團隊時就進行團隊會議。

    「但是會議不是溝通的必要手段嗎?」 是的,會議是必要的。但是過多的會議,尤其是管理不善的會議,會對你的創業公司造成傷害。它們營造出生產力的幻覺,而實際上阻礙了生產力的發展。透過減少對會議的依賴,強調以文件為先的異步溝通,你可以讓團隊在不受 Zoom 會議束縛的情況下進行高效溝通。

    那將是一個很棒的功能

    好好思考一下:每場不必要的會議都會錯過一個機會。那些時間本可以用來完善關鍵演算法,或者用來休息以避免工作太累。簡言之,減少對會議的依賴不僅僅是為了節約時間,更是為了重新獲得專註、創新和創造的能力,這正是創業公司的生命線。

    作為一位經歷過多次創業公司成長的技術聯合創始人,我可以向你保證: 比起開會,你的時間和資源更值得投入到文件編寫上 。大多數會議很容易透過精心起草的檔來替代,該檔呈現相關數據和提出解決方案,並邀請其他人提供反饋。

    💡會議往往會失控。你本來只是召集一個快速的會議來討論一個小問題,但不知不覺中,你卷入了一個長達兩個小時的關於著陸頁 CTA 按鈕顏色的辯論。

    此外,會議往往更加傾向於那些嗓門大的人,而不一定是那些提出最好想法的人。這是一種潛在的存在形式,這可能會扼殺創新和思維多樣性。而文件編寫則能夠平衡這種情況。它為每個團隊成員提供了一個平台,讓他們能夠清晰地表達自己的思想和見解,而不受職位或溝通方式的限制。 它倡導思考和反思的文化,而不是倉促做出判斷和沖動決策。

    你可能認為在全公司範圍內舉行一次會議,並宣布從現在開始將 AI 整合到所有流程中是一個不錯的主意。但實際情況如何呢?在快節奏的創業公司中,細節很容易在忙碌中被忽略。你可能會提到一些事情,開個玩笑,語無倫次,導致溝通不暢,然後你會發現自己又有一個需要解決的問題。將決策以及決策形成的過程記錄下來會非常明了。

    每個決策都是你的創業公司發展的基石,將它們記錄下來可以提供一個堅實的記錄,就像建築藍圖一樣詳細描述你的思考過程、關註點和決策原因。這種清晰性在公司擴張並面臨日益復雜的挑戰時非常寶貴。

    當你將文件納入決策過程中時,它充當了一個知識庫。 它包含了每個決策的背景、見解和所獲得的經驗。當類似情況再次出現時,你可以參考這些文件。這樣做本身就是一種永續發展的技巧。

    作為一位技術創始人,你應該如何推動這一點呢?鼓勵團隊成員記錄他們的決策過程,明確假設、推理和預期結果。在會議上討論這些記錄下來的決策,倡導開放反饋和協作決策的文化。

    這樣做的美妙之處在於,它將每個決策轉化為一個學習機會,培養團隊的成長思維。每個人都能夠看到過去選擇的後果,並理解背後的考慮因素,從而使他們成為更好的決策者。

    建立文件優先的文化

    文件優先文化意味著在創業公司中培養一種共同意識,一種將所有人聯系在一起的統一力量。這不僅僅是嚴格遵循流程的問題,而是民主化知識、打破等級障礙和培養學習文化的過程。文件優先文化並不意味著每個人整天都在忙於撰寫檔。它 意味著每個人都重視記錄和分享自己的經驗的價值

    當構建一個計畫時,文件始終是任何任務的一部份,這是預設的。員工的一部份時間應該用於書寫他們的經歷。這不僅僅是為了提高效率,而是為了創造一個共享知識受到推崇的環境。它是關於創造一種不僅僅創造產品,而是打造一個故事的文化 —— 一個關於集體成長的故事。

    圖片

    你在其中的角色可以是催化劑和促進者, 要始終以身作則 。記錄你自己的流程和決策,並公開分享。始終做好記錄。鼓勵反饋和學習的文化,讓每個文件成為討論、改進和創新的起點。如果需要做出決策,從一個文件開始,而不是一個會議。如果需要進行利弊討論,從一個文件開始。

    💡 作為 CTO,人們會以你為榜樣並仿效你。因為在你的公司中,你所做的一切都是正確的方式,這是一把雙刃劍,所以要謹慎樹立榜樣。

    透過鼓勵同事記錄他們的流程、決策和學習經驗,你表明你重視他們的見解和經驗。這培養了一種超越他們指定角色和任務的歸屬感和參與度。他們成為公司知識庫和成功的積極貢獻者。

    點贊那些寫出優秀文件的人。公開分享它們。祝賀那些和你一樣熱衷於文件的人。

    工具

    接下來, 為團隊成員提供能夠輕松進行文件編寫的工具 。找到一個符合團隊需求和工作流程的工具,可以是共享驅動器、Notion、Confluence、GitLab 或其他知識管理平台,有數百種選擇。請記住,你為團隊成員提供的工具越方便他們進行文件編寫,他們就越有可能去做。

    準備好樣版和指導方針。將它們視為你的文件的 DNA - 它們提供結構、一致性和可預測性,使得知識能夠在組織中有效地復制和傳播。這是一項復雜且耗時的任務,但一旦準備好,後續的工作就會變得非常容易了。

    Remote.Com 概念文件

    樣版確保資訊以標準化的格式記錄,使其易於理解和比較。另一方面,指導方針提供了 「規則」,確保每個人都了解應該記錄什麽,如何記錄以及如何尋找文件。

    💡 建立清單,啟動審查流程,並設定版本控制。這些工具不是限制,而是幫助你的文件以統一的聲音、風格和格式呈現。

    將文件編寫作為公司價值觀的一部份。 鼓勵團隊將其視為工作的不可或缺的一部份,與編寫程式碼一樣重要。將其納入績效評估和反饋會議的例行程式中。鼓勵他們改進文件,並要求他們發現流程中的缺陷。

    隨著創業公司的發展,文件需求也會不斷變化。

    在初創企業中為文件編寫指定一個專門的團隊或個人可能看起來有些奢侈。但請相信我,這是你可以做出的最明智的投資之一。為什麽呢?因為 知識是初創企業的生命線 ,而專門的手冊團隊就像是血液迴圈系統,確保這一重要知識能夠在整個組織中自由、高效地流動。

    💡 當然,並不一定需要一個完整的團隊。一個全職致力於改善文件編寫的人可能會成為巨大的資產。

    這些好處不僅僅局限於知識管理。你的文件團隊可以透過彌合團隊之間的差距、促進跨部門合作和打破壁壘來提高整體組織效率。他們就像是將所有團隊的智慧緊密聯系在一起的粘合劑。

    阻力

    並非每個人都會喜歡這個想法。如果你的初創企業已經經營幾年了,可能會遇到一些阻力。請記住,你所面對的不僅僅是程式碼,還有人。他們的擔憂、舒適區和猶豫不決與任何技術問題一樣真實。你需要以同樣的耐心來對待它們。

    處理抵制的最有效方法之一是參與 。傾聽團隊的擔憂,理解他們的觀點,並回應他們的恐懼。向他們展示采用以文件為先的文化所帶來的好處、效率和自由。而且我要再次強調 —— 樹立你希望看到的行為榜樣,成為首先編寫、分享、學習文件的人,並向他們展示它的價值。

    慶祝那些敢於進入這個房間修理東西的人

    點贊那些采納這種文化的人 —— 他們在以文件為先的方法上取得的成功、努力和進步。這不僅鼓勵他們,還激勵其他人效仿。

    「並非每個人都會喜歡它」 並不是你唯一的問題。文件本身在開始時可能不完美,甚至可能相當糟糕。但不要驚慌。記住, 文件是一個不斷發展的生命體,需要時間來成熟 。作為技術總監,你的角色是確保文件品質隨著時間的推移不斷提高。這不是監管的問題,而是培養的過程。

    好的方式

    首先,解析度和簡潔性非常重要。 這意味著將復雜的概念分解為易於理解的部份,去掉冗余內容,專註於核心要點。你的文件不應該像一本冗長的小說,而應該是他人需要遵循的指南。

  • 例如,在 Notion 中,你可以以不同的方式強調資訊。

  • 如果感覺過於枯燥,就需要重新書寫。

  • 可以添加插圖和視訊解釋。

  • 接下來是結構和組織。 你需要一個有意義且直觀的格式。如果人們無法找到他們需要的內容,他們會迷失並且感到沮喪。你的文件應該引導他們,而不是讓他們感到困惑。

  • 將文件分解成頁面,並在相關文件之間進行交叉連結。

  • 建立一個目錄。

  • 提供 「下一頁」 和 「上一頁」 的連結,提示可能有幫助的其他文件。

  • 接下來是可存取性和可發現性。你的文件不應該是一本藏在塵封的古老圖書館中的秘密寶典。它是一個活躍的、有生命力的資源,需要易於存取和發現。

  • 利用標簽和分類,將資訊分組整理。

  • 利用全文搜尋或 AI 向量搜尋。

  • 最後,這一點至關重要:你的文件不是一座紀念碑。它不是你建立後就遺忘的東西。它是一個不斷增長、不斷演變的實體,需要定期更新和維護。你的組織會發生變化,你的知識會擴充套件,文件需要及時反映這些變化。

  • 跟蹤最後修改的日期,並更新超過一年的內容。

  • 跟蹤資訊的所有者,並定期進行更新。

  • 以下是我推薦研究以獲取一些靈感的幾個開源文件系統:

    GitLab:GitLab 手冊是一個擁有 2000 頁文件的版本控制系統,持續進行更新。我強烈建議閱讀其中的內容。

    https://about.gitlab.com/handbook/

    Strapi:受到 GitLab 全面透明的啟發,也是一個值得閱讀的文件系統。

    https://handbook.strapi.io/

    Remote.com:另一個很好的例子。

    https://remotecom.notion.site/a3439c6ccaac4d5f8c7515c357345c11

    不是銀彈

    我一直在說文件的重要性,感謝你一直閱讀到這裏。但讓我暫時放下我的觀點: 文件雖好,但並非靈丹妙藥 。它不會像超級英雄一樣突然出現,解救你的初創企業的所有問題。它只是一個工具,像任何工具一樣,它有其局限性。你仍然會面臨問題…… 只不過減少了一些而已。

    文件雖然有助於協作,但無法替代人際互動。 它無法復制面對面交流的好處,無法取代即時反饋的價值,也無法替代團隊齊心協力解決復雜問題時的凝聚力。這些會議或者即時交流中建立起來的團隊情感對於培養健康的工作文化和推動團隊動力至關重要。如果你將所有的人際互動都換成一系列文件,那麽你就讓團隊處於孤立和脫節的狀態,這將導致低參與度的問題。

    編寫文件本身可能是耗時的。 編寫實用、簡明和易於理解的文件需要思考、清晰的思路和簡化的技巧。有人可能會認為花費在編寫這些文件上的時間可以在其他地方更好地利用。他們並沒有錯。如果你記錄每一個細節,你將擁有一本龐大的資訊庫,如同在一片茂密的叢林中,難以導航,並且可能沒有那麽有用。

    🚨您知道有時候會有那種文章,花費 2000 個字的篇幅來介紹解決你問題的那一個句子嗎?這就是過度文件化帶來的感受。

    最後,盡管你盡最大努力,文件很快就會過時。技術不斷演進,流程不斷變化,一個月前還相關的內容今天可能已經不再適用。保持文件的最新需要持續的警覺和定期的維護,對於資源有限、快速增長的初創企業來說可能是具有挑戰性的。

    總結

    我對所有年輕的技術愛好者、未來的技術總監和 CTO 的建議很簡單: 培養對文件的熱愛 。你可能把它視為一項任務、一種事後的考慮或者一種麻煩。但是請相信我所說的:文件不僅僅是你待辦事項清單上的一項任務,它是成功的支柱,也是連線思想、人員和願景的橋梁。不要將其視為負擔,而是將其視為學習、分享和產生影響的機會。

    從小事做起,從今天開始。 不要等待完美的策略或者最佳的工具。從記錄你的程式碼、決策和學習經驗開始。將它融入到你的日常工作流程中,而不是將其視為一天結束時的任務。隨著你的發展,將文件化的文化融入到你的團隊、計畫和組織中。建立鼓勵和促進文件化的系統和流程。

    如果有一件事你能從這篇文章中學到,那就是牢記這個口號:「 記錄以賦能,記錄以成長。 」 擁抱這個理念,你會驚訝於它所帶來的改變,不僅僅體現在你的職業生涯中,還會改變你對技術世界的看法和應對方式。

    好書推薦

  • 解構文案打動人的寫作邏輯

  • 掌握爆款文、時事文、幹貨文,AI一鍵式創作

  • 借AI之力,握未來之筆,引領文案革命新浪潮

  • 有靈魂的演講課

  • 六大版塊,教你如何用講故事征服他人!

  • 十年演講金牌課程錘煉

  • 開口就能提升影響

  • 👉 歡迎 ,你將獲得: 專屬的計畫實戰 / Java 學習路線 / 一對一提問 / 學習打卡 / 每月贈書

    新計畫: 仿小紅書 (微服務架構)正在更新中... 。全棧前後端分離部落格計畫 2.0 版本完結啦, 演示連結 http://116.62.199.48/ 。全程手摸手,後端 + 前端全棧開發,從 0 到 1 講解每個功能點開發步驟,1v1 答疑,直到計畫上線。 目前已更新了287小節,累計45w+字,講解圖:2008張,還在持續爆肝中.. 後續還會上新更多計畫,目標是將Java領域典型的計畫都整一波,如秒殺系統, 線上商城, IM即時通訊,Spring Cloud Alibaba 等等,


    1. 

    2. 

    3. 

    4. 

    最近面試BAT,整理一份面試資料Java面試BATJ通關手冊,覆蓋了Java核心技術、JVM、Java並行、SSM、微服務、資料庫、數據結構等等。

    獲取方式:點「在看」,關註公眾號並回復 Java 領取,更多內容陸續奉上。

    PS:因公眾號平台更改了推播規則,如果不想錯過內容,記得讀完點一下在看,加個星標,這樣每次新文章推播才會第一時間出現在你的訂閱列表裏。

    「在看」支持小哈呀,謝謝啦