mirror of
https://github.com/LCTT/TranslateProject.git
synced 2024-12-26 21:30:55 +08:00
Merge pull request #23797 from yingmanwumen/patch-1
Translated 《4 tips to becoming a technical writer with open source contributions》
This commit is contained in:
Xingyu.Wang
GitHub
commit
0dfb551295
@ -1,56 +0,0 @@
|
||||
[#]: subject: "4 tips to becoming a technical writer with open source contributions"
|
||||
[#]: via: "https://opensource.com/article/21/11/technical-writing-open-source"
|
||||
[#]: author: "Ashley Hardin https://opensource.com/users/ashleyhardin"
|
||||
[#]: collector: "lujun9972"
|
||||
[#]: translator: "yingmanwumen"
|
||||
[#]: reviewer: " "
|
||||
[#]: publisher: " "
|
||||
[#]: url: " "
|
||||
|
||||
4 tips to becoming a technical writer with open source contributions
|
||||
======
|
||||
Your open source contributions show potential employers that you take
|
||||
the initiative and seek opportunities to learn, grow, and challenge
|
||||
yourself.
|
||||
![A person writing.][1]
|
||||
|
||||
Whether you’re a tech hobbyist interested in dabbling in technical writing or an established technologist looking to pivot your career to become a professional technical writer, you can build your technical writing portfolio with open source contributions. Writing for open source projects is fun, flexible, and low risk. Contribute to a project of interest to you on your own schedule, and you might be surprised at how welcoming the community can be or how fast you can make an impact.
|
||||
|
||||
Your open source contributions show potential employers that you take the initiative and seek opportunities to learn, grow, and challenge yourself. As with anything, you have to start somewhere. Contributing to open source projects allows you to showcase your talents while also learning new skills and technologies. In addition, writing for open source projects enables you to connect with new communities, collaborate with new people across time zones, and build your network. When you dig into open source opportunities, you enhance your resume and set yourself apart from other candidates. Here are four ways to get started with contributing to open source that can lead to a career in technical writing.
|
||||
|
||||
### Learn the tools of the trade
|
||||
|
||||
To get started, I recommend becoming familiar with [Git][2], setting up [GitLab][3] and [GitHub][4] accounts, and finding a text editor that you like. Personally, I love working with the open source tool [Atom][5]. When it comes to Git, there is a wealth of free learning resources available online, including some excellent interactive tutorials. You don’t need to be a Git master to dive into open source. I recommend learning the basics first and letting your skills develop as you contribute more.
|
||||
|
||||
### Find a project
|
||||
|
||||
The hardest part of contributing to open source can be finding a project to contribute to. You can check out [Up For Grabs][6] and search for projects that interest you. [First Timers Only][7] has more resources on getting started. Don’t hesitate to contact project maintainers to learn more about the project and where they need help. Be persistent. It can take some time to find a project that’s right for you.
|
||||
|
||||
### Say goodbye to imposter syndrome
|
||||
|
||||
A common misconception is that you need to be a programmer to contribute to open source projects. As a self-taught contributor with no engineering or computer science credentials, I can assure you that is not the case. Documentation is often the most valuable but most neglected part of development projects. These projects often lack the people and resources needed to create complete, quality documentation. This presents a great opportunity for you to get involved by submitting pull requests or by filing issues against the project. You can do it!
|
||||
|
||||
### Start small
|
||||
|
||||
Check the repository for the project that you are interested in for possible contribution guidelines to follow. Next, look for opportunities to update README files or to submit typo fixes. No contribution is too small. The project maintainers will likely be happy for the help, and you’ll be glad to get your first pull requests submitted as you build your technical writing portfolio.
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
via: https://opensource.com/article/21/11/technical-writing-open-source
|
||||
|
||||
作者：[Ashley Hardin][a]
|
||||
选题：[lujun9972][b]
|
||||
译者：[译者ID](https://github.com/译者ID)
|
||||
校对：[校对者ID](https://github.com/校对者ID)
|
||||
|
||||
本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译，[Linux中国](https://linux.cn/) 荣誉推出
|
||||
|
||||
[a]: https://opensource.com/users/ashleyhardin
|
||||
[b]: https://github.com/lujun9972
|
||||
[1]: https://opensource.com/sites/default/files/styles/image-full-size/public/lead-images/rh_003784_02_os.comcareers_resume_rh1x.png?itok=S3HGxi6E (A person writing.)
|
||||
[2]: https://git-scm.com/
|
||||
[3]: https://about.gitlab.com/
|
||||
[4]: https://github.com/
|
||||
[5]: https://atom.io/
|
||||
[6]: https://up-for-grabs.net/#/
|
||||
[7]: https://www.firsttimersonly.com/
|
||||
@ -0,0 +1,57 @@
|
||||
[#]: subject: "4 tips to becoming a technical writer with open source contributions"
|
||||
[#]: via: "https://opensource.com/article/21/11/technical-writing-open-source"
|
||||
[#]: author: "Ashley Hardin https://opensource.com/users/ashleyhardin"
|
||||
[#]: collector: "lujun9972"
|
||||
[#]: translator: "yingmanwumen"
|
||||
[#]: reviewer: " "
|
||||
[#]: publisher: " "
|
||||
[#]: url: " "
|
||||
|
||||
成为为开源做贡献的技术写手的四个建议
|
||||
======
|
||||
您的开源贡献将会向潜在雇主表明，您会主动寻求学习、成长和挑战自我的机会。
|
||||
![A person writing.][1]
|
||||
|
||||
不管您是一个对技术写作有所涉足的技术爱好者，还是一个想要转职为职业技术写手的成熟技术专家，您都可以构建您的技术写作作品集，并将您的开源贡献作为作品集的一部分。为开源项目写作是一件有趣、灵活且低风险的事情。按照自己的时间安排来为您感兴趣的项目做贡献，您将会会为社区是多么热情或您对社区产生影响的速度而感到惊喜。
|
||||
|
||||
您的开源贡献将会向潜在雇主表明，您会主动寻求学习、成长和挑战自我的机会。和任何事情一样，您需要从某个地方开始。为开源项目做贡献可以让您在展示您的才华的同时学到新技巧、新技术。另外，为开源项目写作能让您接触到新的社区、跨越时区与新鲜面孔合作，并建立您的社交网络。当您挖掘到新的开源机会后，您的简历将更抢眼，让您在其他候选人中脱颖而出。以下是为开源做出贡献——这可能使您走向技术写作的职业生涯——的四个建议。
|
||||
|
||||
### 学习行业工具
|
||||
|
||||
作为开始，我建议先熟悉 [Git][2]，并建立 [GitLab][3] 和 [GitHub][4] 帐号，然后寻找一个趁手的文本编辑器。我个人喜欢使用开源工具 [Atom][5] 工作。关于 Git，它能从网络上获取到丰富的免费学习资源，包括一些优秀的互动教程。您不必为了跳入开源世界而成为一个 Git 高手。我建议先学习一些基本操作，然后让您的技术力随着您的贡献度逐渐成长。
|
||||
|
||||
### 找到一个项目
|
||||
|
||||
为开源做贡献最难的部分大概是找到一个项目来做贡献。您可以查看 [Up For Grabs][6] 并找一些感兴趣的项目。[First Timers Only][7] 有更多的起步资源。别犹豫，联系项目维护者来了解更多有关于项目的东西，并了解他们在何处需要帮助。请坚持下去。找到一个适合您的项目可能会花费一些时间。
|
||||
|
||||
### 告别“冒充者综合症”
|
||||
|
||||
一个常见的误区是您需要为开源项目编写代码才能为开源项目做贡献。作为一个没有工程或计算机科学领域有关证书的、自学成材的贡献者，我能保证事实并非如此。文档通常是最具有价值的，但是也是开发中项目最容易忽视的部分。这些项目经常缺少人手和资源来建立完善的、有质量的文档。这给您展现了一个绝佳机会来参与提交 Pull Request 或归档针对该项目的 Issues。您可以做到的！
|
||||
|
||||
> 译者注：冒充者综合症（Impostor Syndrome），又称自我能力否定倾向，指个体按照客观标准评价为已经获得了成功或取得成就，但是其本人却认为这是不可能的，他们没有能力取得成功，感觉是在欺骗他人，并且害怕被他人发现此欺骗行为的一种现象。
|
||||
|
||||
### 从小处开始
|
||||
|
||||
查看您感兴趣的项目的仓库，找到可能存在的贡献指南并遵循。然后，寻找更新 README 文档或提交修改错别字的机会。没有什么贡献是微不足道的。项目维护者可能会为这些帮助感到高兴，而您也将会因把您提交的第一个的 Pull Request 收录进您的技术写作作品集而感到愉悦。
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
via: https://opensource.com/article/21/11/technical-writing-open-source
|
||||
|
||||
作者：[Ashley Hardin][a]
|
||||
选题：[lujun9972][b]
|
||||
译者：[yingmanwumen](https://github.com/yingmanwumen)
|
||||
校对：[校对者ID](https://github.com/校对者ID)
|
||||
|
||||
本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译，[Linux中国](https://linux.cn/) 荣誉推出
|
||||
|
||||
[a]: https://opensource.com/users/ashleyhardin
|
||||
[b]: https://github.com/lujun9972
|
||||
[1]: https://opensource.com/sites/default/files/styles/image-full-size/public/lead-images/rh_003784_02_os.comcareers_resume_rh1x.png?itok=S3HGxi6E (A person writing.)
|
||||
[2]: https://git-scm.com/
|
||||
[3]: https://about.gitlab.com/
|
||||
[4]: https://github.com/
|
||||
[5]: https://atom.io/
|
||||
[6]: https://up-for-grabs.net/#/
|
||||
[7]: https://www.firsttimersonly.com/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user