我们出新产品啦,专业漂亮的 API 文档系统

2018-11-20 10:43:59 +08:00
 balabalaguguji

我是技术出生的,一直梦想自己能做点产品出来,不过我想到的产品都是跟技术相关的,这类产品一般属于小众,也赚不到什么钱,所以一般很少人去做好它,但是作为一个技术人员的情怀,我觉得有必要去用心做好它,创业一年多了,终于我们上新产品啦。这次我们要解救开发人员编写文档的痛苦。

我们的产品叫易文档: https://easydoc.xyz ,支持在线接口测试、自定义文档模板、预定义常用参数、分享文档。现在还是 beta 版,可能存在一些问题,大家可以跟我们反馈,我们会进行完善升级。

为什么我会选择做这个? 我们公司是外包+自研产品模式,经常需要些一些接口文档和使用手册,网上找过很多个,都不满意,所以我们决定自己做一套了。

我见过很多公司写接口文档还在用 word,excel,txt,要我用这种写接口文档,我是很痛苦的,首先是编写起来很麻烦,格式要编排好很费力,出来的文档也不漂亮,查找接口又麻烦,另外每次修改了一点东西,都要重新同步给协作者。 当然还有的公司直接就文档都不写,两个人直接坐在一起开发,直接口头传播,当然没问题,但是如果下个人接手你的项目,他就得看代码去了解接口有哪些参数了。

欢迎大家体验,给我们提建议,我们的目标是做最好的用的在线文档管理系统

8113 次点击
所在节点    分享创造
77 条回复
CEBBCAT
2018-11-20 11:57:21 +08:00
又是一个被发帖 bug 坑到发错节点的帖子 @Livid
Livid
2018-11-20 12:00:06 +08:00
@CEBBCAT 什么 bug ?能否稍微描述一下?
Livid
2018-11-20 12:00:25 +08:00
aaronnum7
2018-11-20 12:02:08 +08:00
文档里面,表格的下边框和表头阴影没有对齐,有点强迫症。。。
balabalaguguji
2018-11-20 12:07:17 +08:00
@Livid 我想把它放在分享创造那里的
Cbdy
2018-11-20 12:09:58 +08:00
xyz,挺好的,也很专业,参考字母表公司
建议兼容 swagger 的 api doc 标准
megachweng
2018-11-20 12:12:02 +08:00
和小幺鸡比起来有什么优势
duola
2018-11-20 12:13:22 +08:00
这个可以有,我试一下。
balabalaguguji
2018-11-20 12:30:32 +08:00
@megachweng #27 我们比小幺鸡体验好太多了,不管是编写体验还是预览,你试下就知道了
longjiahui
2018-11-20 12:41:57 +08:00
再把功能完善一下,非常不错!
icella
2018-11-20 12:54:39 +08:00
敢问兄弟 你这个怎么跟 MinDoc 功能和长相都差不多呢 人家是开源的
laike9m
2018-11-20 12:58:02 +08:00
出身,不是出生
hash
2018-11-20 13:00:37 +08:00
看到说 xyz 域名业余,Alphabet 真是泪流满面.
icella
2018-11-20 13:07:27 +08:00
@Chappako 建议看一下那个开源的 MinDoc 总感觉这个推广的跟人家一模一样😛
balabalaguguji
2018-11-20 13:16:54 +08:00
@icella #31 你认真看下我们的,对比下,我们的可以说各方面都比你说的 MinDoc 做的更优秀
Kilerd
2018-11-20 13:20:28 +08:00
那个蓝色的边栏,真的不是抄袭 readthedocs 吗?
icella
2018-11-20 13:39:44 +08:00
@balabalaguguji 你就说是不是参考人家的吧
Asimov01
2018-11-20 13:54:54 +08:00
支持!!!
icella
2018-11-20 13:58:13 +08:00
@Kilerd 整个功能还都是抄袭 MinDoc 呢 可是楼主一直不敢正面回答 呵呵
balabalaguguji
2018-11-20 14:08:07 +08:00
@icella #39 在你说这个 MinDoc 之前,我们都不知道有这个,我们有参考很多其他同类竞品,你说的这个确实不是我们的追求目标

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/509512

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX