mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
a59f8a9eca
* docs: update automations pages for dedicated configure page * docs: unify select terminology in update mode instructions * docs: note that appending runs appear in run history * docs: document grouped runs feed, Modified status, and run actions --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
121 lines
7.9 KiB
Plaintext
121 lines
7.9 KiB
Plaintext
---
|
||
title: "预定义自动化"
|
||
description: "所有预定义 Mintlify 自动化的参考，包括默认触发器、更新模式、上下文仓库支持及必需配置。"
|
||
keywords: ["predefined", "automation", "default"]
|
||
---
|
||
|
||
Mintlify 为最常见的文档维护任务提供了预定义自动化。每个自动化都有一个基础提示词和默认配置。你可以在控制台的 [Automations](https://app.mintlify.com/products/automations) 页面自定义触发器、更新模式和指令。
|
||
|
||
<div id="at-a-glance">
|
||
## 一览
|
||
</div>
|
||
|
||
| 自动化 | 默认触发器 | 默认更新模式 | 上下文仓库 | 必需配置 |
|
||
| ---------- | --------------- | ------------------- | ------------- | ---------------------- |
|
||
| Update from code changes | 自定义计划（每周两次） | Pull request | 支持 | 至少一个源代码仓库 |
|
||
| Draft changelog | 自定义计划 | Pull request | 支持 | 无 |
|
||
| Fill gaps from assistant conversations | 自定义计划 | Pull request | 不支持 | 无 |
|
||
| Improve docs from user feedback | 自定义计划 | Pull request | 不支持 | 已启用反馈收集 |
|
||
| Update from support feedback | 自定义计划 | Pull request | 支持 | 已连接 Intercom、Plain、Pylon 或 Zendesk 集成 |
|
||
| Translate content | 内容更新 | 直接合并 | 不支持 | 至少一个目标语言 |
|
||
| Fix broken links | 内容更新 | Pull request | 不支持 | 无 |
|
||
| Fix SEO issues | 内容更新 | Pull request | 不支持 | 无 |
|
||
| Fix grammar & typos | 内容更新 | Pull request | 不支持 | 无 |
|
||
| Enforce your style guide | 内容更新 | Pull request | 不支持 | 无 |
|
||
|
||
所有默认值都可以在自动化的配置页面中更改。可用选项请参见[配置](/zh/automations/manage#configurations)。
|
||
|
||
<div id="self-updating-content-automations">
|
||
## 自更新内容自动化
|
||
</div>
|
||
|
||
自更新内容自动化会基于你定义的上下文进行更新，以确保你的内容保持准确和最新。
|
||
|
||
<div id="update-from-code-changes">
|
||
### 从代码变更中更新
|
||
</div>
|
||
|
||
监控你的源代码仓库，并针对影响用户的变更打开 pull request 以更新内容。你可以按计划运行该自动化（通常消耗更少积分），或在每次源代码 pull request 时运行。默认情况下，该自动化每周运行两次（周二和周四）。
|
||
|
||
按计划运行时，agent 会读取自上次自动化运行以来所有已合并的源代码 pull request。它会将需要内容更新的相关变更分组到 Mintlify 项目仓库的单个 pull request 中。如果之前运行有未合并的 pull request，agent 会将相关变更追加到现有 pull request 中。agent 会注明变更来自你的源代码仓库的哪些位置。
|
||
|
||
按每个源代码 pull request 运行时，每当你合并一个需要内容更新的代码变更，agent 都会打开一个内容更新 pull request。当你希望内容更新随代码发布立即出现，而不是按计划批量处理时，使用基于推送的变体。
|
||
|
||
你可以为该自动化启用[集成](/zh/automations/integrations)，让 agent 在判断需要更新的内容时，从 Slack 或 Linear 等工具获取额外上下文。
|
||
|
||
<div id="draft-changelog">
|
||
### 起草更新日志
|
||
</div>
|
||
|
||
按周期性计划创建更新日志条目。将源代码仓库添加为上下文，让 agent 对你的产品如何变更有更多细节。如果没有上下文仓库，agent 会根据你的内容更新撰写更新日志条目。
|
||
|
||
<div id="draft-improvements-from-assistant-conversations">
|
||
### 从 AI 助手对话中补齐内容缺口
|
||
</div>
|
||
|
||
审查来自你的 [AI 助手](/zh/assistant/index) 的提问趋势，以识别你内容中的缺口，然后打开一个 pull request 来解决它们。用户与 AI 助手的对话越多，agent 可参考的信号就越多。按周期性计划运行该自动化，以使内容与用户希望了解的产品信息保持一致。
|
||
|
||
<div id="draft-improvements-from-user-feedback">
|
||
### 根据用户反馈改进文档
|
||
</div>
|
||
|
||
审查页面[反馈](/zh/optimize/feedback)——点赞/点踩评分和书面评论——并在用户报告问题的位置更新内容。agent 关注存在反复出现的负面信号的页面，而不是一次性反馈，因此随着反馈累积，结果会变得更好。
|
||
|
||
在使用此自动化之前，你必须在 [Add-ons](https://app.mintlify.com/products/addons) 页面启用反馈收集。
|
||
|
||
<div id="update-from-support-feedback">
|
||
### 从支持反馈中更新
|
||
</div>
|
||
|
||
审查来自 [Intercom](/zh/automations/integrations)、[Plain](/zh/automations/integrations)、[Pylon](/zh/automations/integrations) 或 [Zendesk](/zh/automations/integrations) 的已解决支持会话，以识别你内容中反复出现的缺口，然后打开一个 pull request 来解决它们。agent 关注多次会话中反复出现的主题，而不是一次性问题，因此随着支持量的增长，结果会变得更好。
|
||
|
||
在配置该自动化时选择单一支持平台，如果尚未为你的组织连接，则从配置页面进行连接。将源代码仓库作为上下文添加，帮助 agent 将支持主题与其描述的产品领域关联起来。
|
||
|
||
每次计划运行会将相关发现分组为最多三个主题，并为每个主题分别打开一个 pull request。每次运行都会列出它审查过的已解决支持会话，并链接回源平台，让你可以将每条内容建议追溯到底层的客户反馈。
|
||
|
||
该自动化在包含自定义集成的计划中可用。如果你在 dashboard 中看不到它，请联系你的客户团队。
|
||
|
||
<div id="maintenance-automations">
|
||
## 维护自动化
|
||
</div>
|
||
|
||
维护自动化将常规任务自动化，以提高内容的质量和一致性。你可以通过内容更新触发器或周期性计划来运行它们。
|
||
|
||
在内容更新触发器上运行时，可以以最小延迟维护你的内容。按计划运行通常更节省积分，因为 agent 会在一次运行中批量处理多次变更的工作。代价是从内容变更到自动化对其执行操作之间存在延迟。
|
||
|
||
每个维护自动化都会保留一个开启的 pull request，并在内容变化时持续向其追加新的修复，这样日常维护工作就会汇总到一个待审查的 pull request 中，而不是分散在多个 pull request 里。
|
||
|
||
任何已启用的维护自动化都会在自更新内容自动化创建的 pull request 上运行。如果维护自动化识别出需要的更改，agent 会将工作合并到单个 pull request 中。例如，如果你启用了 **Translate content** 自动化，agent 会将翻译添加到 **Update from code changes** 自动化打开的任何 pull request 中。
|
||
|
||
<div id="translate-content">
|
||
### 翻译内容
|
||
</div>
|
||
|
||
每当变更推送到你的项目仓库时，将更新后的内容翻译为你选择的目标语言。你必须至少指定一种目标语言。Mintlify 会读取你 `docs.json` 中定义的[languages](/zh/organize/navigation#languages)，并预选已配置的目标语言。
|
||
|
||
要禁用某语言的翻译，请删除该语言目录中的所有文件。你无法为仍有已发布内容的语言禁用翻译。
|
||
|
||
<div id="fix-broken-links">
|
||
### 修复失效链接
|
||
</div>
|
||
|
||
每当内容变更推送到你的项目仓库时，查找并修复失效的内部和外部链接。在大规模内容重组之后，或当你引用的外部服务更改其 URL 时运行该自动化很有用。
|
||
|
||
<div id="audit-seo-metadata">
|
||
### 修复 SEO 问题
|
||
</div>
|
||
|
||
每当内容变更时，检查并修复标题、meta 描述、标题和规范标签。添加指令以使 agent 的建议与你的 SEO 策略或目标关键词保持一致。
|
||
|
||
<div id="fix-grammar-and-typos">
|
||
### 修复语法与拼写
|
||
</div>
|
||
|
||
每当内容变更时，查找并修复错别字、拼写错误和语法错误。添加指令以指定 agent 不应更改的技术术语、产品名称或有意的风格选择例外。
|
||
|
||
<div id="apply-style-guide">
|
||
### 强制执行你的风格指南
|
||
</div>
|
||
|
||
每当内容变更时，保持语态、语气和写作规则的一致性。添加指令以定义你想强制执行的具体规则，或链接到你的风格指南。指令越精确，结果越一致。
|