这不是一个很正式的帖子，本来希望等我觉得效果初步变得比较理想再发个帖子出来，但觉得作为开源社区，让大家一起协同努力应该会有更好的效果。所以还是想简单先给论坛的开发者同步下相关的信息，然后也号召感兴趣的朋友参与进来。

大家可能都知道 DTK 的文档一直都不是很理想，目前 DTK 组其实也在改善现有的文档质量。关于 DTK 的文档，我们目前确定了下面的这些策略：

• 文档基于 doxygen 进行生成
• 文档会同时在三个地方进行提供，以满足各个需求的使用：
  • （自 v23 起）提供文档包（例如 libdtkwidget-doc），可以直接安装，并用于在 QtCreator 中直接查阅文档
  • 在 GitHub Pages 提供开发分支的实时文档生成（目前 DTK 核心组件已经有了，参见这里）
  • 在开发者平台提供已发布的稳定版的文档（暂时还没有准备好）

其中，关于开发分支的文档生成是各位目前最直接就可以看到效果的途径，并且此途径产生的是实时文档，所以只要有相关更新就会很快体现到网站上来。而开发者平台上目前仍是比较旧的文档，但目前的目标是，后续开发者平台上的文档也会采用相同来源（doxygen）生成的文档，并以恰当的形式提供给开发者们。

如果各位目前就直接点进开发分支的实时文档的话（比如假定各位点了 dtkwidget 的 master 分支文档），可能会看到一个光秃秃的首页。实际的文档各位可以在顶部导航的【类>类列表】里查看到了。当然里面的文档质量目前也有待提升（比如缺失文档、错误的提供了私有类的文档、未对中英文文档进行恰当标记、使用了 qdoc 而非 doxygen 的标记等问题）。

相关的文档问题，DTK 的维护人员在慢慢的处理了，但我觉得这个可以号召广大开发者一起来改善。doxygen 的文档标注格式并不复杂，加上整个流程本身也不复杂，所以即便之前没有参与过开源贡献，这也会是个不错的用来上手的机会，并且可以切实的改善各位的文档查阅的体验。deepin 目前有开发者的实时聊天频道，感兴趣的朋友可以加入进来一起完善。尝试贡献的过程中，如果遇到任何问题，我们也很乐意帮助解答 :)

顺便，我们最近有新一期的开源实习生活动，这期的活动形式有点近似 bug bounty，而其中有关于文档贡献相关的任务。所以如果有想比较长期的参与文档贡献的小伙伴也欢迎报名这次的开源实习生 :)

然后等文档的完成度比较好的时候，我再发个正式点的帖子吧（bushi

各位如果有什么想法的话，也可以提出来