文档很糟糕（我可能让它好一点）

Source: Dev.to

背后的故事

技术文档很烂。我们都知道这一点。但我们仍然一次又一次地使用同样的工具。我最近换了新职位，在离开当前公司之前，我的任务之一基本上是文档地狱——把你参与的每个项目的所有部分都记录下来。工作量很大。

对于这种技术文档，你通常有三种选择：

• 一段冗长、痛苦的视频，没人会完整观看。
• 添加一堆 README 文件（枯燥且同样痛苦）。
• 使用类似 Notion 的工具并复制代码片段。

我知道还有其他工具，但我没有找到很多能够很好地将代码与富文本融合，创建视觉上吸引人的编辑器和阅读器的。于是，我自然决定自己动手…

产品

并没有花太久——大约 3–4 周——我最终做出了一个 体面 的文档解决方案。它叫 Doclific，目前已经作为 npm 包发布。它免费、开源，代码库相对简单，易于浏览。

Doclific 基本上就是 Git 和 Notion 的“孩子”。它提供：

• 一个漂亮的编辑器，具备层级结构的笔记功能。
• 斜杠命令，可快速插入元素。
• 直接的代码片段引用（不再需要复制粘贴）。
• AI 集成——只需添加你的提供商、模型和密钥。
• 存在于你的代码库中，无需额外费用或维护外部文档。

我最喜欢的功能

代码片段元素 – 通过斜杠命令添加，然后浏览到具体文件，选择行号，片段会在每次加载时显示。如果仓库中的代码发生变化，片段会在下次打开 Doclific 时自动更新。每个片段还包含一个链接，点击后会在 VS Code 中打开对应文件并将光标定位到指定行，导航轻而易举。

AI 集成 – 其他同类产品没有的惊人功能。让 AI 为特定工作流生成文档，它会定位相关文件，选取合适的行，添加描述、标题等，并将所有内容连同代码片段一起插入文档。

致谢

特别感谢 Platejs 的维护者们。他们提供了许多出色的富文本编辑器组件。

结束语

欢迎分享你对这款工具的看法。如果有任何建议或问题，随时联系我！