跳转到内容
搜索文档

如何操作

最后更新 查看 MarkdownAgent 设置

目的

如何操作(how-to)文档的目的是说明如何完成产品内的某项任务。

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

语气

指导性、直截了当

content_type

pcx_content_type: how-to
products:
  - product-a
  - product-b
  - product-c

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

结构

必需组件

标题:第二人称祈使语气中的短动词短语。不要使用动名词短语。

步骤:完成任务的有编号步骤。

后续步骤:用户应看到的步骤最终结果和/或可执行的后续步骤。

可选组件

上下文:关于后续步骤及其将要完成之任务的介绍性段落。

向读者提供章节标题中未包含的上下文信息。

以冒号或句号结尾。如果紧接在步骤之前,请使用冒号。如果上下文和步骤之间还有其他材料(例如注释),请使用句号。

不要使用由编号步骤补全的残缺句子来为步骤提供上下文。

前提条件:用户在完成一系列步骤之前必须完成的任务或满足的条件。

注释/警告

示例

屏幕截图

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

模板

单一程序的如何操作文档


---
weight: xx
pcx_content_type: how-to
description: <动词> <Cloudflare 产品或功能> 以 <任务达到的目的>。<关键细节或前提条件>。
products:
  - product-a
  - product-b
  - product-c
---

# 第二人称祈使动词短语

程序的上下文(可选)

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

后续步骤句子 - 用户应看到的最终结果和/或可执行的后续步骤。

包含多个程序的如何操作文档


---
weight: xx
pcx_content_type: how-to
description: <动词> <Cloudflare 产品或功能> 以 <任务达到的目的>。<关键细节或前提条件>。
products:
  - product-a
  - product-b
  - product-c
---

# 第二人称祈使动词短语

页面上程序的上下文(可选)

## 第二人称祈使动词短语

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

后续步骤句子 - 用户应看到的最终结果和/或可执行的后续步骤。

## 第二人称祈使动词短语

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

后续步骤句子 - 用户应看到的最终结果和/或可执行的后续步骤。

必须按顺序完成的包含多个程序的如何操作文档


---
weight: xx
pcx_content_type: how-to
description: <动词> <Cloudflare 产品或功能> 以 <任务达到的目的>。<关键细节或前提条件>。
products:
  - product-a
  - product-b
  - product-c
---

# 第二人称祈使动词短语

页面上程序的上下文(可选)

## 1. 第二人称祈使动词短语

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

后续步骤句子 - 用户应看到的最终结果和/或可执行的后续步骤。

## 2. 第二人称祈使动词短语

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

后续步骤句子 - 用户应看到的最终结果和/或可执行的后续步骤。

## 3. 第二人称祈使动词短语

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

后续步骤句子 - 用户应看到的最终结果和/或可执行的后续步骤。

这篇文档对您有帮助吗?