V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
initialdp
V2EX  ›  问与答

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

  •  
  •   initialdp · 2013-12-24 10:48:23 +08:00 · 2827 次点击
    这是一个创建于 3991 天前的主题,其中的信息可能已经有所发展或是发生改变。
    比如我们的产品有很多说明文档(有文字、图像等,无语音、视频)、技术资料,一般是免费给客户看的。这些都可以公开的文档,似乎放在github上不错。客户如果发现问题或者错误,也可以及时反馈。

    缺点就是这样会不会显得不正规?比如用户访问了我们的官方网站,点击之后给跳转到github去查资料等等。有人这么弄吗?
    4 条回复    1970-01-01 08:00:00 +08:00
    Golevka
        1
    Golevka  
       2013-12-24 10:53:35 +08:00
    反馈问题通过邮件就好. 另外你让所有的客户都把issue挂在同一个列表上是不是不太合适? 还是你指望客户会给你提交pull request?
    initialdp
        2
    initialdp  
    OP
       2013-12-24 11:01:10 +08:00
    @Golevka 我的想法有点类似于把github当wiki用。因为都是些产品、业务说明文档,用户如果有补充或者发现描述错误,可以直接提意见,甚至直接改了就好。
    biaobiaoqi
        3
    biaobiaoqi  
       2013-12-24 12:14:00 +08:00
    比如七牛的sdk就有放到github上,不过同时他们的官网也有维护。
    稳妥点我想可以把github作为一个补充吧,透露出公司、产品团队 互联网的基因。如果只是使用github来展示,似乎确实不够诚意的感觉-,-
    westy
        4
    westy  
       2013-12-24 12:25:34 +08:00
    我们是文档用Markdown写,然后放在public repo里,然后用readthedoc服务渲染出来~
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   3584 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 24ms · UTC 10:52 · PVG 18:52 · LAX 02:52 · JFK 05:52
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.