开源项目参与_通过更好的文档吸引更多的项目参与人

开源项目参与

这种情况并不少见有消息各地的社区是不友好的妇女或新人或人谁是不是已经有一个周期。 “新闻”是指某人发布了一些关于自己的不公正行为的贴心内容，而其他人对此发表了评论或撰写了自己的帖子，总的来说，这个故事的寓意是： 但是我们应该比这更好！

作为整个社区的一部分，这是正常且理想的行为。这个周期是一件好事，因为它使人们思考自己作为社区成员的行为，成为局外人的感觉以及他们如何改善。这些都是积极的步骤，因为它源于对成为更好人的诚实渴望。棒极了。

在开源文章中查看完整的初学者集合

最近，我一直在研究一些我不常涉足的技术领域。通过查看文档，一个领域正在研究一项新技术。这个特殊的旅程是从成为Glass Explorer开始的，这是我在amye.org上自己的博客中谈到的一个故事，因此在此不做赘述。但是，深夜，当我翻阅有关Android实际功能以及智能手机硬件能够完成的所有这些（坦率的惊人）事情（大气压力，有人吗？）的文档时，我为之震惊是我们时代最伟大的水平仪之一。

每个人都必须阅读文档。大家。您知道那些时候您跳进去，不打扰阅读手册，然后想知道为什么它不起作用的时候吗？好吧，是的...这发生在每个人身上。 “只是下载来尝试一下”的人和编写大量代码的人都对文档有既得利益。当然，他们的兴趣范围各不相同，但它们都是有效的。我觉得这有点像刚刚学习音乐的三年级学生和可以即时朗读的专业钢琴家，但是他们都需要分数才能知道接下来要演奏的音符。

在这种情况下，您在开源社区中的文档说明了您对社区的期望。我意识到我将收到有关您的代码如何进行自我记录的大量评论。不，亲爱的先生和女士，事实并非如此。期望您的代码能够自我记录，就像在森林中标记单个树而无需注意森林的位置。这是在北极吗？热带地区？提起它，我可能会在岩石下面找到什么样的生物？我在看什么，我期望下一个在哪里？

我很喜欢Android文档，因为它是一个平台，几乎可以随时让您知道。它有明确的定义和布局，但是仍然有一些词汇不熟悉。

前一段时间我碰到了@relsqui的这条推文，它一直困扰着我……

理论：缺乏文件证明会导致冒名顶替综合症。 “我应该已经知道这一点/能够自己解决……”

这就是我坚持使用它的原因-它可能是一种理论，但理论是最高的科学定律，这取决于我们是否予以反驳。您可以做很多事情；在完成项目时仅保留运行中的文本文档也是有帮助的。

底线：如果您不打算记录自己为他人所做的事情，那么为将来的自己做些什么，他们将在六周后回来并且不记得要去哪里？

在“开源周”文章中查看完整的初学者集合。

翻译自: https://opensource.com/life/14/2/why-documentation

开源项目参与

开源项目参与_通过更好的文档吸引更多的项目参与人相关推荐

【githubshare】开源的文件文档在线预览项目，支持主流办公文档的在线预览，如 doc、docx、Excel、pdf、txt、zip、rar、图片等
GitHub 上一份硬核计算机科学 CS 自学计划,偏向软件工程和系统架构方向. 旨在帮助开发者制定一个为期 3-5 年的重学 CS 目标,夯实 CS 基本功,达到美国一流大学 CS 专业本科毕业水平 ...
JAVA微信开源项目（jeewx）百度BAE 部署文档
JeeWx(捷微) 百度BAE 部署文档开始前的准备 1. WAR包下载地址: 链接: http://pan.baidu.com/s/1bnlcsk3 密码: 592i 下载war包和sql脚本文 ...
wms策略文档_内容策略：技术文档的新理念
wms策略文档我们是否可以首先同意文档很重要,而我们想要更好的文档呢? 好. 这样一来,我就不必为为什么要关心而写三段式的报告了,这样您就可以保留更多的时间来阅读它会花费您的时间. 为了生意! 作为 ...
python开发技术文档范文_程序员编写技术文档的新手指南
这是一篇帮助你给第一个项目写文档的指南. 万事开头难,我希望这份指南能把你引导到正确的道路上. 最后,你应该有一个可以公开发布的项目. 请轻松地阅读完这篇文章,或者简单地把它当作参考. 为什么要写文档 ...
文档加载状态_我们如何确定技术文档的状态？
文档加载状态 GitHub最近的一项调查中,超过90%的受访者表示,开源项目的主要问题之一是文档不完整或令人困惑. 我们该如何解决? GitHub用户认为文档质量差是#opensource项目的主要问 ...
网站项目标准文档格式模版---网站项目建设流程概述（转）
网站项目标准文档格式模版---网站项目建设流程概述(转) 一.概念网站项目管理就是根据特定的规范.在预算范围内.按时完成的网站开发任务. 二.需求分析项目立项我们接到客户的业务咨询,经过双 ...
JAVA-文件文档在线预览项目解决方案-kkFileView
1. 简介 kkFileView是文件文档在线预览项目解决方案,对标业务付费产品有永中office,office365,idocv等.该项目使用六星的springboot大家,易上手和部署,基本支持 ...
制药企业SAP项目中CSV认证需要准备的文档
制药企业SAP项目中CSV认证需要准备的文档 CSV,英文全称是Computerized System Validation,中文是计算机化系统验证.很多行业的企业信息化建设过程中,都要确保自己实施的 ...
sphinx文档_使用Sphinx构建自定义文档工作流
sphinx文档 Sphinx是用于创建文档的流行应用程序,类似于JavaDoc或Jekyll. 但是,与其他工具相比,Sphinx的重组文本输入允许更高程度的自定义. 本教程将说明如何自定义Sphi ...

开源项目参与_通过更好的文档吸引更多的项目参与人

在开源文章中查看完整的初学者集合

开源项目参与_通过更好的文档吸引更多的项目参与人相关推荐

最新文章

热门文章