有人在github上放产品的说明文档么?

2013-12-24 10:48:23 +08:00
 initialdp
比如我们的产品有很多说明文档(有文字、图像等,无语音、视频)、技术资料,一般是免费给客户看的。这些都可以公开的文档,似乎放在github上不错。客户如果发现问题或者错误,也可以及时反馈。

缺点就是这样会不会显得不正规?比如用户访问了我们的官方网站,点击之后给跳转到github去查资料等等。有人这么弄吗?
2823 次点击
所在节点    问与答
4 条回复
Golevka
2013-12-24 10:53:35 +08:00
反馈问题通过邮件就好. 另外你让所有的客户都把issue挂在同一个列表上是不是不太合适? 还是你指望客户会给你提交pull request?
initialdp
2013-12-24 11:01:10 +08:00
@Golevka 我的想法有点类似于把github当wiki用。因为都是些产品、业务说明文档,用户如果有补充或者发现描述错误,可以直接提意见,甚至直接改了就好。
biaobiaoqi
2013-12-24 12:14:00 +08:00
比如七牛的sdk就有放到github上,不过同时他们的官网也有维护。
稳妥点我想可以把github作为一个补充吧,透露出公司、产品团队 互联网的基因。如果只是使用github来展示,似乎确实不够诚意的感觉-,-
westy
2013-12-24 12:25:34 +08:00
我们是文档用Markdown写,然后放在public repo里,然后用readthedoc服务渲染出来~

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

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

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

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

© 2021 V2EX