蕪湖達內IT培訓
美國上市IT培訓機構
18130056197
軟件的下一個飛躍：修復內部文檔
- 時間：2020-12-21 10:07
- 發布：InfoQ
- 來源：InfoQ
你以前聽過這個故事嗎?一位經驗豐富、備受重視的軟件工程師加入了一家新公司。她急切地提供價值。她的團隊渴求提高生產力，因為每個人都忙得不可開交。然而，她所發現的是一個龐大的、文檔化程度低的、令人費解的代碼庫。
花了好幾個月的時間，她才搞清楚所有的東西在哪里，什么東西在哪里。同時，團隊的生產力也在下降，因為他們需要指導她完成部分代碼，而這些代碼有時連他們自己都不太記得。
預計到2024年，全球軟件工程師的數量將達到近2900萬，每年引進大約100萬名新開發者。與此同時，科技行業的營業額也在不斷增長，與其他行業相比，目前是最高的。
由于每年有300萬到400萬的工程師在更換公司，還有數百萬的工程師在不同的團隊或項目之間轉換，所以使用新的代碼庫已經成為軟件開發的最大挑戰之一。
軟件工程師是所有軟件公司和研發部門中最受歡迎和最有價值的資源。在未來十年內，提高軟件工程師的工作效率預計可使全球GDP增加3萬億美元，96%的C級主管表示，提高開發者的工作效率是他們組織中的中高優先事項。
由于新冠肺炎疫情爆發，提高生產力和效率的需求變得更為迫切，許多新開發者都是從遠程辦公開始，不能獲得同等水平的辦公室內培訓和經驗。
對于工程師來說，很少有事情像新代碼庫的入門流程那樣阻礙他們的工作效率。近幾年來，我和幾十家公司的經理們就工程師上崗問題進行了討論。
在這些公司中，工程師們完全掌握技術所需的時間通常需要三到九個月的時間。有些情況下，他們會花上一整年的時間。這種情況對于與快速發展的公司或人員流動頻繁的工資尤其有害，因為他們的工程師中有很大一部分并沒有完全發揮出生產力，而其余的工程師們則忙于幫助他們。
內部文檔化很難進行
對于外部觀察者來說，解決方案似乎很簡單：在創建和更改代碼時，推廣文檔化的文化，這樣，新員工入職過程就會變得更加精簡和優雅。在全球范圍內這樣做，你將會獲得更高的工作效率。
然而，幾十年的代碼項目已經表明，創建和維護內部文檔由于各種原因是一個巨大的挑戰：
這是一項耗時的投資。
要保持新鮮和相關性，就需要更多投資。
創建代碼遠比記錄文檔更令人興奮，更有成就感。
并不是每一個開發者都是文檔化的擁護者，這導致了文檔的編寫得很糟糕，與代碼和工作流的鏈接也很槽糕。
由于開發者偏好不同的平臺，所以文檔往往分散在不同的平臺上，而不利于集成和使用。
在文檔化方面的投資主要是一種利他主義行為，需要團結和同理心，而這種團結和同理心很少是自然發生的。這就需要管理層的重視和資源分配。
這種動態性使得許多人認為，有文檔和沒有文檔一樣有用。有些人提倡“自文檔化代碼”，要求代碼清晰、組織有序，不需要其他文檔。然而，事實證明，這種方法同樣難以培養和維持，因為它也需要利他主義、努力、時間和技能。
顛覆時機已成熟
隨著開發者工具市場的穩步增長和資本的涌入，似乎新一代文檔工具的基礎已經準備就緒。然而，要想產生重大影響，新工具需要解決以下幾個重要問題：
維護自動化：文檔化問題的癥結在于需要花費時間和精力來更新文件。新的工具必須在不降低質量的情況下解決這一問題。
工作流程的一部分：如果文檔化仍然是你在不進行編碼的時候所做的事情，那么就永遠不會有足夠的時間去做好它。在開發過程中使用文檔工具，并將其納入開發過程，以最小的努力實現它。
與代碼相結合：當文檔脫離代碼本身時，它往往會脫離實際而失去意義。只有代碼才是真理的源泉：只是很少有足夠的清晰和組織。文檔應該解釋原因、上下文和流程，但要將它們與代碼中的相關部分直接聯系起來。
開發者的喜愛：如果這些工具要得到開發者的認可，就必須得到他們的喜愛。事實證明，“開發者體驗”是開發工具的決定性因素，在這種情況下也不會例外。
新冠肺炎疫情爆發產生了破壞性的影響，但也加速了新技術的開發和采用。事實證明，遠程辦公是一個艱巨的挑戰，而新的工具在今天的環境中提供了肥沃的土壤和機會，從而永遠地改變了代碼文檔的創建和維護方式。
作者介紹：
Tom Ahi Dror，Swimm首席品牌官，致力于改變開發者進入新代碼庫的方式。
原文鏈接：
https://www.forbes.com/sites/forbestechcouncil/2020/12/09/softwares-next-big-leap-fixing-internal-documentation/?sh=7799f69613bb
【免責聲明】本文系本網編輯部分轉載，轉載目的在于傳遞更多信息，并不代表本網贊同其觀點和對其真實性負責。如涉及作品內容、版權和其它問題，請在30日內與管理員聯系，我們會予以更改或刪除相關文章，以保證您的權益！
免費預約達內試聽課
Copyright ? Tedu.cn All Rights Reserved 京ICP備08000853號-56 達內時代科技集團有限公司 版權所有
選擇城市和中心
北京
內蒙古
山東省
江蘇省
上海
湖南省
江西省
貴州省
廣西省
廣東省
海南省
臺灣