文档章节

1K star+ 的项目是如何炼成的?

crossoverJie
 crossoverJie
发布于 2018/05/15 08:37
字数 1450
阅读 136
收藏 1

alarm-clock-art-background-1037993.jpg

前言

首先标题党一下,其实这篇文章主要是记录我的第二个过 1K star 的项目 Java-Interview,顺便分享下其中的过程及经验。

4.png

需求选择

Java-Interview

之所以要做这个项目主要是当时我正在面阿里的两个部门,非常幸运的是技术面都过了。其中的过程真是让我受益匪浅更是印象深刻,所以就想把期间的问题记录下来,加上自己的理解希望能对其他朋友起到帮助。

正好那段时间也是传说中的金三银四,所以无形中也叫顺势而为吧😏。

SSM

这个项目的历史就比较悠久了,我看了下第一次提交差不多是两年前。

从这个名字也可以看出当初还是一个刚入行没多久的小菜鸟,因为之前在学 Java 的时候真的走了很多冤枉路,所以从头开始记录到现在整个过程所学到的东西,踩过的坑。

由于是面向小白,入门简单,上手较快也取的了一定的关注。

其实从这两个项目可以看出选择一个方向是很重要的

以及该项目解决了什么问题,长期的规划,受众是哪些都要考虑清楚(怎么有点像做产品😅,其实这就是你自己的产品)。

比如这两个项目的目标:

  • Java-Interview:持续更新面试问题,希望能让面试者知其然也知其所以然。
  • SSM:博主从小白到现在实际开发所遇到的问题记录,以及实战经验,现在逐渐会分享一些难点以及底层。受众大多是小白。

文档很重要

既然项目做出来是给人用的,那文档就显得至关重要了。

就像日常和前端怼接口时,有一个标准的文档输出比在白板上折腾半天要高的多。

C0DA2F29-C334-46BC-8BED-14CD6B6C5349.png

其实仔细观察 GitHub 上热门的项目,会发现他们的文档几乎都有一些共同结构:

  • 简单描述项目是干什么的。
  • 快速启动。
  • 最近更新。
  • Q/A 答疑。
  • 项目截图。

主要目的就是要简单易读,快速上手。

然后把一些复杂的如系统设计、开发指南等可以放到 wiki 中。

切记不要什么东西都往 README.MD 中写,保持一个简洁的文档可以加分哦。

当然也可以在首页加入一些徽章如:

3.png

也能起到一些积极作用。

积极推荐

代码质量这个就不多说了,这应该是最基本的要求。

俗话说:酒香不怕巷子深。

但对于做开源项目来说就不太适应了,当你幸辛苦苦做了一个自认为很不错的项目,结果一年过去了都无人问津,这不免会有点打击积极性。

所以适当的自我推荐就很有必要了。

7D819139-647F-43E3-9DB2-AB80A3E6BC7B.png

1.jpg

2.png

上图是我博客、项目的主要流量来源。

下面是我自身体验比较优质的推荐渠道:

  • 开发者头条:由于截图的时候没有新发文章,之前那篇秒杀架构实践发了之后博客 80% 的流量都是从头条过来的,而且质量很高,不得不点个赞。
  • 并发编程网: 并发编程网是由阿里大牛清英(买了那本《并发编程的艺术》就被圈粉了)创办的,其中的文章质量普遍较高(导致也会有一点写作门槛)。由于网站的流量也比较高,只要你的文章质量不错肯定会得到好处。
  • 掘金:掘金这两年也比较火,是专门做开发者内容的,也是网站流量不错。
  • 开源中国:开源中国的博客也不错,自己也有代码托管,但我还是更喜欢用 GitHub,一般上了编辑推荐都会有不错的访问量。
  • V2EX:大名鼎鼎的 V 站,其实受众较少,正因为如此也形成了独有的文化,因此也是我每天比逛(摸鱼)的网站,由于受众大多是开发者所以也能得到很多有用的反馈。
  • 大佬推荐:最快捷的方式其实就是口口相传,其中当然是大佬的效率最高。之前有个纯洁的微笑程序猿DD 都投过稿,也能带来不错的流量。
  • 简书:本来不想推荐简书的(之前的事件以及现在鸡汤太多),但是流量还可以,现在就纯粹当做博客备份的工具了。

坚持下来之后会发现:只要自己坚持、保证质量最后会形成自己的阅读圈子,到后面甚至会有其他朋友主动来找你分享,这些都是自我提升的过程。

不忘初心

当初做的第一个开源项目就是 SSM,完全受够学习时找资料的痛苦,也得到了很多人的帮助,所以才有了该项目。

平时工作中或多或少都会用到开源项目,其实我们大部分人也写不出 Spring、Guava 这样的项目,只是再这过程中可以参与进去,收获也是非常丰富的。

两年前参与开源到现在有收到面试邀请、物质奖励这些都是正面积极的,可以鼓励我们接着做下去。

但最多的还是在这过程中结识了很多朋友,技术能力提升也很明显,这些都是保持自我可持续发展的必要条件。

输入图片说明

© 著作权归作者所有

crossoverJie

crossoverJie

粉丝 714
博文 97
码字总数 187484
作品 0
江北
后端工程师
私信 提问
加载中

评论(1)

红薯
红薯
放码云呗,我们推荐一下
围观! 2018 开年 1k+ star 及码云 GVP 项目是如何炼成的

码云Gitee 始终致力于推动国内开源生态的建立与良好发展,在竭诚为广大开发者提供更好的远端代码托管、协作开发服务的同时,也推出了码云开源项目 “GVP” 与 “1000 Star” 计划,大力扶植和...

码云Gitee
2018/02/01
6.4K
11
EggJS 1.0.0 正式发布 - 企业级 Node.js 框架

时光如梭,转眼间 Egg.js 已经开源半年了,我们很荣幸地宣布,Egg.js 正式发布 1.0 版本。 官网传送门:https://eggjs.org GitHub:https://github.com/eggjs/egg Egg.js 英文文档:与 Swif...

天猪(刘勇)
2017/03/21
0
0
Egg.js 1.0.0 正式发布 - 企业级 Node.js 框架

时光如梭,转眼间 Egg.js 已经开源半年了,我们很荣幸地宣布,Egg.js 正式发布 1.0 版本。 官网传送门:https://eggjs.org GitHub:https://github.com/eggjs/egg Egg.js 英文文档:与 Swif...

天猪
2017/03/24
6
0
百亿访问量的监控平台如何炼成?

百亿访问量的监控平台如何炼成? 运维派2017-12-262 阅读 监控 前言: 很开心能够跟大家分享 WiFi 万能钥匙在监控领域做的一些事情,本文分享的主题是《百万访问量的监控平台 […] 点赞 监控...

运维派
2017/12/26
0
0
iview组件轮子。可能是你想要的二级城市多选。

01 需求来源 前阵子项目中有一个城市多选的需求,分解后有以下几个需要实现的指标: 一次性展示中国的所有省份 省份的下属城市,在鼠标hover到省份上时也触发显示 支持局部全选和反选 省份下...

chokingwin_cw
2018/06/02
0
0

没有更多内容

加载失败,请刷新页面

加载更多

redis 学习2

网站 启动 服务端 启动redis 服务端 在redis 安装目录下 src 里面 ./redis-server & 可以指定 配置文件或者端口 客户端 在 redis 的安装目录里面的 src 里面 ./redis-cli 可以指定 指定 连接...

之渊
23分钟前
0
0
Spring boot 静态资源访问

0. 两个配置 spring.mvc.static-path-patternspring.resources.static-locations 1. application中需要先行的两个配置项 1.1 spring.mvc.static-path-pattern 这个配置项是告诉springboo......

moon888
今天
3
0
hash slot(虚拟桶)

在分布式集群中,如何保证相同请求落到相同的机器上,并且后面的集群机器可以尽可能的均分请求,并且当扩容或down机的情况下能对原有集群影响最小。 round robin算法:是把数据mod后直接映射...

李朝强
今天
4
0
Kafka 原理和实战

本文首发于 vivo互联网技术 微信公众号 https://mp.weixin.qq.com/s/bV8AhqAjQp4a_iXRfobkCQ 作者简介:郑志彬,毕业于华南理工大学计算机科学与技术(双语班)。先后从事过电子商务、开放平...

vivo互联网技术
今天
21
0
java数据类型

基本类型: 整型:Byte,short,int,long 浮点型:float,double 字符型:char 布尔型:boolean 引用类型: 类类型: 接口类型: 数组类型: Byte 1字节 八位 -128 -------- 127 short 2字节...

audience_1
今天
9
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部