Skip to main content
通过工作区规则和记忆，将 Windsurf 打造成一名深谙你的风格指南、组件和项目上下文的文档专家。

​
将 Windsurf 与 Mintlify 搭配使用

Windsurf 的 Cascade AI 助手可以结合 Mintlify 组件进行调优，使其按照你的规范撰写文档。工作区规则与记忆为你的项目提供持久化上下文，帮助 Cascade 输出更一致的建议。
  • 工作区规则 存放在你的文档代码库中，并与团队共享。
  • 记忆 提供随时间累积的个人上下文。
我们建议为共享的文档规范配置工作区规则。你可以在实际使用中逐步积累记忆，但由于记忆不共享，团队成员之间的一致性无法保证。 在你的文档代码库的 .windsurf/rules 目录中创建工作区规则。更多信息请参见 Windsurf 文档中的 Memories & Rules。

​
示例工作区规则

此规则为 Cascade 提供关于 Mintlify 组件及通用技术写作最佳实践的上下文。 你可以直接使用此示例规则，或根据你的文档进行定制：
  • 写作规范：更新语言指南，使其与您的风格指南一致。
  • 组件模式：添加项目特有的组件或修改现有示例。
  • 代码示例：用与您的产品相关的真实 API 调用和响应替换通用示例。
  • 风格与语气偏好：调整术语、格式和其他规则。
将此规则以 .md 文件保存到文档代码库的 .windsurf/rules 目录中。

​
使用 Cascade

设置好规则后，您可以使用 Cascade 协助完成各类文档任务。更多信息请参阅 Windsurf 文档中的 Cascade。

​
示例提示

撰写新内容：
换行
改进现有内容：
换行
编写代码示例：
换行
保持一致性：
换行