谷歌推出「文件季」計畫,改進開源文件質量

2021-09-16 19:10:45 字數 901 閱讀 1462

谷歌推出了「文件季」計畫,旨在改進開源專案的文件質量。它將通過在開源貢獻者和技術作者之間建立指導關係來實現該目的,從而幫助各種開源技術建立更強大、更全面的文件。

「文件季」的動機來自開源調查,該調查表明,很多開源專案缺乏良好的文件。谷歌認為,這是因為文件的建立相當困難,所以啟動了這個計畫來改進開源專案的文件質量。

該計畫的潛在參與人員將分為兩大類,導師或技術作者,這兩者將合作產出文件。谷歌解釋道:

在「文件季」期間,技術作者將花上幾個月的時間與開源社群緊密合作。每個作者與其所選擇的開源專案合作。作者們把他們的專業知識用於專案文件,同時學習有關開源和新技術的知識。

技術作者首先會進入探索階段,找到他們可能感興趣的專案。在此之後,他們可以和相應的組織討論他們的想法。接著進入申請階段,如果申請成功,技術作者就可以開始處理文件,並在此期間與導師緊密合作。

就像技術作者一樣,導師也將經過申請階段。在該階段,他們也將被要求找到將技術作者緊密合作的導師。如果申請被接受,他們將負責從技術作者申請人中選擇技術寫作專案。

在具體的工作方面,專案可能涉及建立全新的文件、改進已有的文件或更好地記錄開源貢獻過程。

讓我們一起提高公眾對開源文件、技術寫作以及我們如何合作造福全球開源社群的意識。

符合條件的導師必須積極運作開源專案,而技術作者要能夠展示以前的技術寫作經驗。技術作者還將獲得工作補貼。

谷歌已經為該計畫制定了時間表,導師的申請提交從4月份開始,技術作者的申請提交從5月份開始。更多相關資訊請參考**,內容包括如何參與該項目的步驟以及常見問答。

檢視英文原文:google launches 「season of docs」 program to improve open source documentation

用IO寫入和寫出文件

讀取 private void readlogfile 關閉釋放讀資料流 read.close 返回讀到的日誌檔案內容 return output.tostring 寫入 private void writelogfile string input 建立只寫檔案流 using filestream ...

使用freemarker利用模板匯出文件

本文旨在對在使用freemarker建立模板匯出文件是遇到的一些錯誤及解決方案做個記錄。現在網路上有很多這樣的 隨便一查就有很多。但是為了方便大家使用我這裡就在網上隨便摘抄一些,方便使用。首先建立模板。1 使用office軟體建立乙個文件,文件設定好自己的樣式 顏色等格式。2 在你要插入值的地方定義...

谷歌熱榜推出 2007 旅遊專題

十一在即,有沒有為這七天長假制訂乙個出行計畫好好放鬆一下呢?如果還沒有想好去哪,谷歌熱榜推出 2007 旅遊排行幫您的忙。看看什麼地方去的人多,可以大致了解下。我們根據近期真實搜尋資料,分析使用者所想,用最直觀的排行榜形式,向您推介最受關注的旅遊資訊。在這裡,您不僅可以一覽國內 8 個地區各個區域的...