Doclific 是一款开源的内部文档工具,旨在从源头杜绝文档漂移。与其把技术文档散落在各个 wiki 和外部工具中,不如让所有文档直接存放在代码仓库里,使文档始终贴近它所描述的代码。
借助类 Notion 的富文本编辑器,写文档变得轻松简单,支持标题、列表和代码块。对于更复杂的说明场景,Doclific 还提供 ERD 图表绘制和架构白板功能,让你可以在文字旁边直接可视化数据模型和系统设计。
文档中最令人头疼的问题之一是代码示例过时。Doclific 通过支持直接从代码库引入动态代码片段来解决这个问题,让示例随代码的演进而同步更新。
Doclific 还内置了 AI 支持(目前基于 Google Gemini),可自动生成文档,帮你省去撰写那些没人想写的文档所耗费的时间。
它在本地运行且速度快,无需任何外部服务,内部知识永远不会离开你的基础设施。未来还将通过 CI 集成,自动保持文档与代码库的同步。

评论
正在加载评论…