码农不重视文档:开源项目深受其苦
GitHub 刚刚发布了《2017 开源调查》报告,这家知名编程社交网站走访了 github.com 社区内 3800 多个项目和超过 5500 名成员,并且与 500 名在 GitHub 项目生态系统之外的编程者们进行了交谈。本次调查涉及多方面,比如人们在为开源项目做开发、做贡献时遇到的问题,结果有 93% 的人对“不完整或令人困惑的文档”感到非常沮丧。
然而这没能出乎我们的意料,因为 GitHub 上确实有许多描述很稀疏的项目,缺乏如何去使用它们的知道。如果你的脑实力不够强大,肯定会独自栽在这上面。
很遗憾,很多码农忽视了文档对一个项目取得成功的重要性。科技作者 Mike Pope 曾经如此总结文档的需求:
我们需要告诉开发者,‘缺了文档,就等于废了项目’!(If it isn’t documented, it doesn’t exist.)
你不仅必须写文档,还得在其中好好解释、教导和示范。这样的话,大家都会很高兴的。这不仅关乎你的文档,也关乎你的产品!
此外,Stack Overflow 创始人 Jeff Attwood、以及 JavaScript 开发者 Nicholas Zakas,也都在博文中强调过文档的重要性。
GitHub《2017 开源调查》中排名靠前的几个问题,在“文档不完整或困惑”之后,分别是“不回应”、“不屑”、“冲突”、“不明原因的拒绝”、以及“不欢迎的语言或内容”。
GitHub 在调查中强调:“文档有助于营造一个包容性的社区,清楚地解释了一个项目的过程,比如贡献指南和行为准则,大家会很珍视这样的开源工作、但它往往被低估”。
调查还指出,高达 60% 的贡献者很少或从未对文档提供过帮助。
原文地址:http://www.cnbeta.com/articles/soft/618585.htm
.NET社区新闻,深度好文,微信中搜索dotNET跨平台或扫描二维码关注
码农不重视文档:开源项目深受其苦相关推荐
- java计算机毕业设计宠物领养管理系统源码+数据库+系统+lw文档+部署
java计算机毕业设计宠物领养管理系统源码+数据库+系统+lw文档+部署 java计算机毕业设计宠物领养管理系统源码+数据库+系统+lw文档+部署 项目架构:B/S架构 开发语言:Java语言 开发软 ...
- java计算机毕业设计员工培训管理系统源码+数据库+系统+lw文档+部署
java计算机毕业设计员工培训管理系统源码+数据库+系统+lw文档+部署 java计算机毕业设计员工培训管理系统源码+数据库+系统+lw文档+部署 项目架构:B/S架构 开发语言:Java语言 开发软 ...
- java计算机毕业设计山西农谷企业产品推广展网源码+系统+数据库+lw文档+mybatis+运行部署
java计算机毕业设计山西农谷企业产品推广展网源码+系统+数据库+lw文档+mybatis+运行部署 java计算机毕业设计山西农谷企业产品推广展网源码+系统+数据库+lw文档+mybatis+运行部 ...
- 计算机毕业设计springboot精准扶贫项目管理系统q0y06源码+系统+程序+lw文档+部署
计算机毕业设计springboot精准扶贫项目管理系统q0y06源码+系统+程序+lw文档+部署 计算机毕业设计springboot精准扶贫项目管理系统q0y06源码+系统+程序+lw文档+部署 本源 ...
- 基于Java毕业设计服务管理系统源码+系统+mysql+lw文档+部署软件
基于Java毕业设计服务管理系统源码+系统+mysql+lw文档+部署软件 基于Java毕业设计服务管理系统源码+系统+mysql+lw文档+部署软件 本源码技术栈: 项目架构:B/S架构 开发语言: ...
- java计算机毕业设计学校食堂订餐管理源码+数据库+系统+lw文档+部署
java计算机毕业设计学校食堂订餐管理源码+数据库+系统+lw文档+部署 java计算机毕业设计学校食堂订餐管理源码+数据库+系统+lw文档+部署 本源码技术栈: 项目架构:B/S架构 开发语言:Ja ...
- 基于JAVA传统文化知识竞赛系统计算机毕业设计源码+系统+数据库+lw文档+部署
基于JAVA传统文化知识竞赛系统计算机毕业设计源码+系统+数据库+lw文档+部署 基于JAVA传统文化知识竞赛系统计算机毕业设计源码+系统+数据库+lw文档+部署 本源码技术栈: 项目架构:B/S架构 ...
- java计算机毕业设计流行病调查平台源码+数据库+系统+lw文档+mybatis+运行部署
java计算机毕业设计流行病调查平台源码+数据库+系统+lw文档+mybatis+运行部署 java计算机毕业设计流行病调查平台源码+数据库+系统+lw文档+mybatis+运行部署 本源码技术栈: ...
- java计算机毕业设计劳务外包管理系统源码+系统+数据库+lw文档+mybatis+运行部署
java计算机毕业设计劳务外包管理系统源码+系统+数据库+lw文档+mybatis+运行部署 java计算机毕业设计劳务外包管理系统源码+系统+数据库+lw文档+mybatis+运行部署 本源码技术栈 ...
最新文章
- HDU 4738 Caocao‘s Bridges(桥、任何位运算一定都要加括号、因为有重边所以用前向星)
- 带你学习JQuery:事件冒泡和阻止默认行为
- hbase delete.deleteColumns问题
- 常用系统存储过程有:
- zookeeper无故挂掉,启动不起来的问题
- oracle字符串使用函数,Oracle常用函数介绍之一(字符串)
- DevOps平台中的自动化部署框架设计
- EntityFramework 实体拆分与表拆分
- 小程序使用微信地址or小程序跳转设置页
- linux vi 上下左右 ab,【Linux】Ubuntu vi 上下左右变ABCD及 apt-get install报错问题解决方法...
- (转)Hibernate中的多表操作
- linux vim替换指定字符串
- android 投屏与控制,android投屏pc及电脑adb控制手机
- 数据驱动测试该怎么理解?真的像传说中的那么diao吗?
- 通达信缠论顶底分型选股公式(一笔优化版)
- Chrome无法安装axure插件
- 在LibreOffice 中启用录制宏的功能
- tecplot——Fluent重叠网格解决方案
- 如何架设一个属于自己的Discuz论坛
- Atcoder Codefestival Exhibition/Team Relay/Tournament Round 简要题解
热门文章
- HDU 2996 In case of failure [KD树]
- bigpipe merge对F5做批量配置
- Windows2008应用之配置客户端自动添加打印机
- C# 11 中的参数 null 检查
- 还在纠结Dapper或者EF Core?不妨试试“混合ORM”--RepoDb
- 这批.Net程序员水平不行啊!居然ASP.NET Core Middleware都不会用
- 如何在 ASP.Net Core 使用 分布式缓存
- abp vnext2.0核心组件之.Net Core默认DI组件切换到AutoFac源码解析
- 使用BeetleX.NetBenchmark压测TCP,HTTP和Websocket服务
- C#中Array.Sort()方法分析