如何通過為開源項(xiàng)目做貢獻(xiàn)來提高你的技術(shù)寫作技巧
首先，您可以從事經(jīng)常公開展示的項(xiàng)目。這可能是向您的專業(yè)網(wǎng)絡(luò)展示您的技能的好方法。
此外，與流行的看法相反，代碼并不是您可以為開源項(xiàng)目做出貢獻(xiàn)的唯一方式。您可以使用您的寫作技巧來幫助維護(hù)人員改進(jìn)他們的項(xiàng)目文檔。
為開源做貢獻(xiàn)會(huì)讓你接觸到新技術(shù)語言和軟件，勞工統(tǒng)計(jì)局將其描述為技術(shù)作家的許多重要技能之一。
還是不相信？別擔(dān)心——在本指南中，我將討論如何找到需要技術(shù)作家的開源項(xiàng)目。我還將描述對(duì)這些項(xiàng)目的技術(shù)寫作相關(guān)貢獻(xiàn)可能是什么樣子，并建議如何公開展示它們。
（更|多優(yōu)質(zhì)內(nèi)|容：java567 點(diǎn) c0m）
如何識(shí)別需要技術(shù)寫作貢獻(xiàn)的開源項(xiàng)目
許多開源項(xiàng)目在文檔方面需要幫助。選擇一個(gè)項(xiàng)目來做出基于文檔的貢獻(xiàn)將在很大程度上取決于您的興趣、您擁有的寫作技巧水平以及可用的機(jī)會(huì)。 ?
在尋找需要貢獻(xiàn)的開源項(xiàng)目時(shí)，我強(qiáng)烈建議向您的同事詢問他們參與的項(xiàng)目。與朋友合作+開源？一個(gè)的價(jià)格是兩個(gè)！:) 選擇項(xiàng)目后，我的下一個(gè)提示是執(zhí)行以下操作：
轉(zhuǎn)到項(xiàng)目存儲(chǔ)庫上的問題選項(xiàng)卡。
指向問題選項(xiàng)卡的黃色箭頭
\2. 單擊標(biāo)簽部分
指向標(biāo)簽部分的橙色箭頭
\3. 在文本框中輸入“documentation”，瞧瞧！
文本框中出現(xiàn)“文檔”
現(xiàn)在，如果您正在尋找更具體的東西，這里是我的開源項(xiàng)目列表，重點(diǎn)是文檔：
好文檔項(xiàng)目
如果您希望開始獲得使用文檔的經(jīng)驗(yàn)，我強(qiáng)烈建議您加入這個(gè)小組。:) 他們有不同的工作組，專注于不同類型的寫作，無論是創(chuàng)建其他開發(fā)人員可以在他們自己的開源項(xiàng)目中使用的文檔模板，改進(jìn)組織網(wǎng)站上的內(nèi)容，還是對(duì)模板進(jìn)行 QA（質(zhì)量保證）社區(qū)成員創(chuàng)建。
代碼學(xué)院
如果您精通某種特定的編程語言并希望與全世界分享這些知識(shí)，那么我強(qiáng)烈建議您為 Codecademy 的文檔和文章存儲(chǔ)庫做出貢獻(xiàn)。他們根據(jù)不同的需求提供模板，例如為特定章節(jié)提供新條目和更新/編輯現(xiàn)有條目。
天文
如果您是 Astro 的狂熱用戶，那么您可以在他們的文檔庫中分享使用該軟件的技巧。他們的文檔團(tuán)隊(duì)非常愿意與具有不同經(jīng)驗(yàn)水平的成員合作。
現(xiàn)在選擇一個(gè)項(xiàng)目只是一個(gè)步驟。讓我們看看作為技術(shù)作家可以為開源項(xiàng)目做出貢獻(xiàn)的一些不同方式。
作為技術(shù)作家為開源做出貢獻(xiàn)的方法
恭喜！你已經(jīng)選擇了你的項(xiàng)目?，F(xiàn)在，您只需要決定如何使用您的技術(shù)寫作技能來做出貢獻(xiàn)。
我知道這部分可能很困難，但不要擔(dān)心——現(xiàn)在我們將討論您可以做出的一些不同類型的貢獻(xiàn)。
修改 README 文件中的拼寫錯(cuò)誤和其他語法錯(cuò)誤
該文件對(duì)于開源項(xiàng)目的基礎(chǔ)至關(guān)重要。這是他們描述項(xiàng)目目的和貢獻(xiàn)步驟的地方，因此應(yīng)該盡可能清楚地寫下來。
如果您在通讀 README 文件時(shí)發(fā)現(xiàn)缺少逗號(hào)或句子不明確，請(qǐng)向維護(hù)者提出問題并進(jìn)行編輯（當(dāng)然，如果他們同意的話）。
當(dāng)我第一次加入他們的社區(qū)時(shí)，我就為 EddieHub 做出了貢獻(xiàn)。這不僅是自我介紹的好方法，而且還教會(huì)了我如何為特定受眾定制文檔?，F(xiàn)在這不是唯一的基于文本的貢獻(xiàn)，讓我們看看另一個(gè)！:)
創(chuàng)建內(nèi)部文檔樣式指南
這需要?jiǎng)?chuàng)建一個(gè)指南，該指南定義了編寫和格式化開源項(xiàng)目文檔的標(biāo)準(zhǔn)。它有助于指導(dǎo)貢獻(xiàn)者如何有效地為開源寫作。
在本文檔中，您將看到諸如標(biāo)點(diǎn)符號(hào)應(yīng)該和不應(yīng)該如何書寫、格式化代碼塊的具體方法以及貢獻(xiàn)者在撰寫有關(guān)產(chǎn)品的文章時(shí)應(yīng)該使用的語氣和語氣等信息。
一個(gè)很好的例子就是Google 開發(fā)者文檔樣式中的縮寫部分。
此外，在從Document Write 的 YouTube 頻道觀看了 Portia 的視頻后，我決定為 EddieHub 的 Linkfree 項(xiàng)目制作一個(gè)文檔風(fēng)格指南。她談到了開源貢獻(xiàn)者，尤其是那些想以科技寫作為職業(yè)的貢獻(xiàn)者，如何從這些風(fēng)格指南中受益。
通過創(chuàng)建本指南，我學(xué)到了以下內(nèi)容：
以新的風(fēng)格或語言編寫：由于 Linkfree 的主要人口在英國，因此維護(hù)人員希望該指南以英式英語編寫。我以前從未使用過這個(gè)版本的英語，所以學(xué)習(xí)單詞的拼寫、大寫以及使用的標(biāo)點(diǎn)符號(hào)很有趣。
使用新技術(shù)工具或框架：MDX (Markdown X)是貢獻(xiàn)者用來維護(hù) Linkfree 文檔的技術(shù)語言。簡單地說，是 Markdown 允許你放置JSX（讓你將 HTML 代碼放入 JavaScript 的語法）。我曾短暫地使用過 Markdown，因此在創(chuàng)建文檔指南時(shí)實(shí)現(xiàn)這種語言要容易一些。
現(xiàn)在，風(fēng)格指南只是您可以為開源項(xiàng)目做出的眾多基于文檔的貢獻(xiàn)之一。讓我們?cè)倏纯戳硪粋€(gè)！:)
添加到產(chǎn)品教程
如果您擅長教學(xué)或發(fā)現(xiàn)自己正在閱讀缺少關(guān)鍵信息的開源軟件教程，請(qǐng)考慮將此作為您的貢獻(xiàn)。
Audacity 網(wǎng)站上的教程部分就是一個(gè)很好的例子。它是一款免費(fèi)的開源音頻錄制和編輯軟件。 ?
作為開源社區(qū)的新人，我注意到大多數(shù)初學(xué)者級(jí)別的內(nèi)容從未真正提供有關(guān)貢獻(xiàn)者如何在找工作或面試時(shí)實(shí)施他們的開源貢獻(xiàn)經(jīng)驗(yàn)的提示或建議。因此，我在 GitHub 上瀏覽 OpenSauced 的存儲(chǔ)庫，發(fā)現(xiàn)這類內(nèi)容對(duì)他們的免費(fèi)“開源簡介”課程很有幫助。
我向公司的用戶體驗(yàn)負(fù)責(zé)人Bekah介紹了我的想法，創(chuàng)建了一個(gè)拉取請(qǐng)求，然后 violà，它被合并了！ ?
我強(qiáng)烈建議做出這種貢獻(xiàn)，因?yàn)楂@得實(shí)踐的一種好方法是為所有技能水平的全球受眾簡化技術(shù)內(nèi)容。它還可以培養(yǎng)您注重細(xì)節(jié)的技能。
現(xiàn)在，在您開始之前，通過為開源項(xiàng)目做貢獻(xiàn)獲得技術(shù)寫作經(jīng)驗(yàn)時(shí)，還需要考慮一件事。
展示你的作品
當(dāng)談到展示您的作品的重要性時(shí)，Austin Kielon 說得最好：“展示您的作品”。 ?
我的意思是，我們是大聲吶喊的作家！通過文字顯示內(nèi)容是我們的 DNA，那么為什么不用我們自己的東西呢？ ?
你可以通過你的博客、社交媒體帖子來寫你的項(xiàng)目，或者錄制一個(gè)關(guān)于它的播客片段。
如果您正在尋找更結(jié)構(gòu)化的內(nèi)容，我建議您使用OpenSauced的免費(fèi) Chrome 擴(kuò)展程序。它是一種工具，可讓您跟蹤您當(dāng)前貢獻(xiàn)和計(jì)劃貢獻(xiàn)的 GitHub 開源存儲(chǔ)庫。
他們還有一個(gè)稱為“亮點(diǎn)”的功能，您可以在其中選擇某些貢獻(xiàn)以發(fā)布到您的個(gè)人資料并在 LinkedIn 和 Twitter 上分享。要了解如何操作，請(qǐng)查看他們的教程。
這將是您在工作面試中參考的好東西，它可以為其他開源貢獻(xiàn)者提供靈感。當(dāng)我在 Twitter 上展示我為 Linkfree 創(chuàng)建的文檔樣式指南時(shí)，我的一位同事非常喜歡它，以至于她認(rèn)為為她的項(xiàng)目提供一個(gè)文檔樣式指南會(huì)很好。所以根據(jù)她的要求，我創(chuàng)造了一個(gè)！:) 永遠(yuǎn)不要低估展示您作品的力量。
伙計(jì)們，這就是您通過為開源項(xiàng)目做出貢獻(xiàn)來獲得寫作經(jīng)驗(yàn)的指南。我知道這樣做可能會(huì)令人生畏——尤其是一開始——但有了這些技巧和積極的態(tài)度，我知道你會(huì)成功的。
