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

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

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

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

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

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

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

8129 次点击
所在节点    分享创造
77 条回复
icella
2018-11-20 14:33:48 +08:00
@balabalaguguji 页面排版都一样,这么巧合
balabalaguguji
2018-11-20 16:39:40 +08:00
@zifangsky #19 导出离线文档的功能我们会在后面些时间提供
balabalaguguji
2018-11-20 18:42:56 +08:00
@lniwn 嗯,现在是收集大家反馈完善阶段,我们不断开发完善
CEBBCAT
2018-11-21 01:18:38 +08:00
@Livid #21 说不清,给一下复现步骤:

1. 打开 /new
2. 点击分享创造按钮(就是那个链接到 javascript:chooseNode('create') 的)

这时候发现节点选成了 C/C++/Obj-C/c,复现完毕

说实话,这是老 bug 了,很老很老。一起想反映的还有节点选单不全的问题。20 号凌晨( CST ),我试着在反馈节点下发帖,被告知发主题帖间隔要大于 10 分钟,从 FAQ 找到 support 那个邮箱之后,心又很累,就没有发邮件

当然了,若是你或者其他我不知道存在不存在的开发人员没有时间,那可以适当延后,因为最近 V2EX 似乎没有改变

以上是一个普通用户在凌晨敲下的反馈,可能有点语气低落,抱歉
以上
CEBBCAT
2018-11-21 01:19:28 +08:00
@CEBBCAT Emmm,说好十一点睡觉的,又被室友拖累了 doge
Livid
2018-11-21 02:47:40 +08:00
@CEBBCAT 谢谢你的描述。初步猜测是节点名里的某个特殊字符导致的问题。我会去看看。目前,V2EX 的代码就是我一个人在写。作为一个两个孩子的父亲,时间确实很紧张。
balabalaguguji
2018-11-21 09:46:20 +08:00
@Livid 能否帮我恢复到分享创造那个分类呢,我是想发到那里去的,你这个 bug 导致错位了
Livid
2018-11-21 10:03:12 +08:00
@balabalaguguji 已经移动。

在主题最初发布的 10 分钟之内,如果对所在节点不满意,是可以自由移动的。
xunqin
2018-11-21 10:14:14 +08:00
https://www.kancloud.cn/

这种网站现在很多了
hydyy
2018-11-21 11:12:23 +08:00
为啥要造这种轮子
balabalaguguji
2018-11-21 12:55:47 +08:00
@xunqin #49 看云我们知道,API 文档你有用过他的写吗?你对比下,我保证你会爱上我们这个,我们这个更加专注 HTTP 文档这些,编写和预览的体验都是超越所有竞品的。当然我们除了对 API 文档支持很好外,对使用手册这种也是支持很好的。
balabalaguguji
2018-11-21 12:58:33 +08:00
@hydyy #50 因为市面上没有任何一款产品能达到我们的要求,我们希望编写 API 文档的体验是畅快的,阅读是让人愉悦的。你能找出比我们体验更好的吗?
kios
2018-11-21 13:32:42 +08:00
请问楼主这个和 readthedoc 有什么区别吗?
edsheeran
2018-11-21 13:41:08 +08:00
@kulove abc.xyz 打臉
wuhai
2018-11-21 15:09:19 +08:00
技术出身的。。不是出生的。。
sunny2580839896
2018-11-21 15:45:11 +08:00
不可以解析 json,很烦
hydyy
2018-11-21 17:21:52 +08:00
@balabalaguguji 目前用 https://yapi.ymfe.org/ 体验也是极好的
balabalaguguji
2018-11-21 18:43:19 +08:00
@sunny2580839896 #56 后面我们会支持
balabalaguguji
2018-11-21 18:44:30 +08:00
@kios #53 readthedoc 是直接用 markdown 的,写接口文档特麻烦,你用下就知道了
nicoljiang
2018-11-21 18:46:25 +08:00
支持楼主创造。
虽然我觉得 yapi 足够优秀漂亮了,而且可以私有化部署。

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

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

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

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

© 2021 V2EX