跳转到内容
搜索文档

解决方案指南

最后更新 查看 MarkdownAgent 设置

目的

解决方案指南适用于带着目标或问题而非产品名称访问的用户。有些用户知道自己面临问题并需要解决它。有些用户则刚刚开始,想知道应该配置什么。在这两种情况下,该指南都会识别出适用哪些 Cloudflare 产品,并引导用户将它们配置在一起。

解决方案指南回答了这样一个问题:“我想做 X。我需要什么,为什么每个部分都很重要,以及如何设置它?”

解决方案指南位于 /use-cases/solutions/{guide-slug}/,独立于任何具体产品板块。这种放置方式确保了尚未选择产品的用户能够发现它们。

何时使用此内容类型

如果您不确定要使用哪种内容类型,请参阅选择内容类型

语气

引导式、通俗的语言。选择一条推荐路径并坚持执行。解释每个配置步骤背后的原理,以便读者理解原因,而不仅仅是做什么。在首次使用时定义技术术语。编写概念性部分时,应确保没有网络或安全背景的读者也能理解。

如果因计划级别、基础设施配置或用户偏好存在有意义的替代方案,请在标注中列出,并附上指向相关文档的链接。替代方案不应中断主路径,也不应要求读者在继续之前做出决定。

content_type

pcx_content_type: solution-guide
products:
  - product-a
  - product-b
  - product-c

有关更多详细信息,请参阅 pcx_content_type

标注

使用标注在指南中相关的节点列出有意义的替代方案。最常见的情况是某个功能需要比核心工作流所假设的更高的计划级别。请务必附上指向相关文档的链接。

核心工作流应该能够在 Free 或 Pro 计划中实现。不要将仅限 Enterprise 的功能作为指南的主要路径。

使用此模式:

:::note[可选标题]
[替代方案的简短描述及其适用情况。]请参阅[相关文档链接]。
:::

结构

工作流阶段组织内容,而不是按产品。每个部分都应该有一个清晰的结果,以便读者在继续下一步之前知道自己完成了什么。

必需组件

标题:通俗语言的目标陈述,反映用户试图完成的任务,而不是产品名称。

  • 推荐:"阻止恶意 Bot 同时允许合法流量"
  • 避免:"Bot Management 配置指南"

介绍:一至两段描述用户遇到的问题以及为什么该问题很重要的内容。在明确问题之后再引入涉及的 Cloudflare 产品,而不是在此之前。

步骤:每个工作流阶段中的有编号步骤。每个步骤都应说明要做什么以及为什么这很重要。

标注:在存在有意义的替代方案的每个决策点,包含一个带有指向相关文档链接的标注。请参阅标注获取模式。

可选组件

前提条件:用户开始之前必须满足的条件。保持最低限度且具体的条件。

注释/警告

图表

屏幕截图

相关链接:关联资源的无序列表链接。

模板

---
pcx_content_type: solution-guide
title: 通俗语言的面向目标的标题
description: 使用 <所涉及的 Cloudflare 产品> <读者将完成的工作>。涵盖 <关键工作流阶段>。
---

# 通俗语言的面向目标的标题

描述用户遇到的问题以及为什么该问题很重要的介绍性段落。在确立问题之后引入涉及的产品,而不是在此之前。

## [第一工作流阶段]

### [第一个任务]

为什么此步骤很重要。

1. 第一步
1. 第二步
1. 第三步

:::note[可选标题]
[替代方案的简短描述及其适用情况。]请参阅[相关文档链接]。
:::

### [第二个任务]

...

## [第二工作流阶段]

...

这篇文档对您有帮助吗?