何时写Wiki何时写Issue - DigitalPlatform/dp2 GitHub Wiki

Wiki说明

• Wiki是正式文档，不适合进行跟帖讨论。
• wiki 应该是具有权限的人才能进行创建和编辑吧，也限制了参与者的范围。 (待确认）
• wiki可以备份克隆到本地

Issue说明

• Issue主要是系统bug，需求改进，功能讨论，疑问解决等
• Issue可以讨论和跟帖.

何时写Wiki，何时写Issue?

如果要编写文档，有两个办法：一个是在 Issues 里面讨论和逐渐完善编写，好处是能跟帖，大家参与；二是单独一个人在 Wiki 里面编写和充实。后面一种方法，Issues 可以作为补充，比如某个人发现 Wiki 有错，自己权限不够，改不了，在 Wiki 里面也无法跟帖，就可以专门就这个事儿在 Issues 里面提交一个 Issue。

Wiki 可以慢慢编写。比如稳定的，正确的内容已经有了，但时间不够一次全部编写完，就每天填写增加一点内容也可以。已经提交的内容，别人就可以观看了，只是内容不完整而已，但依然是很有价值的。

如果连正确性都不能保证，要询问讨论修改，那就放在 issues 里面解决好了。

为了避免 issues 里面细碎的 issue 太多不方便观看，可以集中一些类型的只开一个 issue。比如凡是对 wiki 提意见的都在一个特定 issue 下面跟帖。

Issue 中一般是放一些临时性的讨论，最终是要被关掉的。可以将关闭或结束的Issues拷贝整理出来贴到 wiki 中，方便大家查阅。

总结

• 一般权限人员前期所有问题和讨论都写到Issues里
• Issues中讨论的差不多了或者形成终稿的文档，可以由指定人员发到Wiki里
• 正式有权限的人员可直接发布Wiki，需保证基本正确性，内容可慢慢充实。