Github issue

  • 优点:
    • 最适合讨论,可以@ 提醒
    • reference 功能很棒,可建立双向联系
    • 添加标签, 便于识别查找
    • 讨论完 close 便是, 相当于归档
  • 缺点:
    • 不方便在本地编辑
  • 适宜的用法:
    • 有关具体问题, 开发过程等的讨论
    • 记录不成熟的想法以供讨论

Github wiki

  • 优点:
    • 可以作为一个 repo clone 到本地编辑/查看
      • 也可方便地查看历史版本
    • 便于组织文档, 效果类似网站, 且比 gitbook 轻便
    • 用心打造一个wiki, 应该是很酷很有建设性的事儿
  • 缺点:
    • 无法讨论互动
  • 适宜的用法:
    • 可组织管理各种成熟不成熟的个人文档及参考资料
    • 尤其是: 对讨论需求不高的, 以及不准备发布到 Gitbook 的
    • 可为其他场合提供链接作为reference

Gitbook

  • 优点:
    • 具备 wiki 的大部分优点: 可本地编辑, 美观地组织文档.
    • 具备 issue 的最大优点: 可供讨论.
    • 可方便地下载为 pdf, mobi 等格式
    • 更正式, 更有成品的感觉
  • 局限:
    • 一般用于成熟文档的发布
    • 用于讨论, 不像 issue 那样轻便灵活. 确切的说, 两者适用于不同类型的讨论
  • 适宜的用法:
    • 成品教程的输出

补充

  • 另外, 个人文档, 教程草稿/素材等 可存在为知笔记中, 用 sublime text 编辑, 需要发布时另存到本地相应仓库目录下.
  • 以上只是一些琐碎的个人感受. 实际中的使用方法当然不该局限于此. 都有人用 issue写博客了, 还有什么不可能呢.

results matching ""

    No results matching ""