This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

建议的 Dapr 文档模板

新 Dapr 文档文章的建议模板指南

1 - 概念文章模板

创建概念文章的建议模板和指导

贡献新的概念或概述文章

概念（或概述）文章回答以下问题：

  • 为什么要关注此功能？
  • 它能帮助你解决哪些问题？

虽然组件、API 或 SDK 规范可能帮助读者了解如何使用或使用这些功能，但概念文章提供了更深层次和上下文。可以链接到规范文章，但尽量不要简单重复规范内容。

在命名概念文章时，确保名称、参数和术语与规范保持一致。必要时确保两者都得到更新。

了解更多关于贡献 Dapr 文档的信息，例如 front-matter 和 shortcodes。

模板

---
type: #Required; docs
title: #Required; 简短、清晰的标题
linkTitle: #Required; 简短标题
weight: #Required; 根据层级使用正确的权重
description: #Required; 一句话描述文章内容
---

<!--
在打开 PR 之前，请删除此模板中的所有注释。
-->

<!-- 
H1：Hugo front-matter 中的标题作为文章的 markdown H1。 
-->

<!-- 简介
必需。简要介绍文章将涵盖的概念。链接到相应的参考、规范或操作指南以提供上下文。 -->

<!-- 
如果可能，包含图表或图像。 
-->

## <第 1 节 H2>

<!-- 
在此添加你的内容。  
-->

## <第 2 节 H2>

<!-- 
每个 H2 步骤应以名词/描述性词开头。
-->

## <第 3 节 H2>

<!--
在此添加你的内容。
-->

<!--
在适用的地方，通篇包含图表或图像。
-->

## 尝试 <概念>

<!-- 
如果适用，包含一个部分，链接到相关的快速入门、操作指南或教程。 --> 

### 快速入门和教程

想要测试 Dapr <主题> API？完成以下快速入门和教程，查看 <主题> 的实际应用：

| 快速入门/教程 | 描述 |
| ------------------- | ----------- |
| [<主题> 快速入门](link) | 快速入门的描述。 |
| [<主题> 教程](link) | 教程的描述。 |

### 直接在应用中使用 <主题>

想要跳过快速入门？没问题。你可以直接在应用中尝试 <主题> 构建块。[安装 Dapr](link) 后，即可开始使用 <主题> API，从 [<主题> 操作指南](link) 开始。


-->

## 后续步骤

<!--
链接到相关页面和示例。例如，相关 API 规范、相关构建块等。
-->

2 - 快速入门指南模板

创建快速入门指南的建议模板和指导

贡献新的快速入门指南

Dapr 快速入门指南包含简明的说明，引导读者完成准备好的快速入门，这些内容保存在 dapr/quickstarts 仓库中。这些快速入门将整个功能或构建块打包在一起，使读者能够轻松体验其工作方式，而无需影响自己的项目。

快速入门说明应简洁、直接、清晰。快速入门指南的唯一目的是简单地指导读者完成准备好的快速入门。如果您想解释快速入门背后的概念，请引导读者阅读概念文章以获取更多背景信息。

了解有关贡献 Dapr 文档的更多信息，例如 front-matter 和 shortcodes。

模板

---
type: #必需；docs
title: #必需；"Quickstart: 简洁、清晰的标题"
linkTitle: #必需；这将显示在文档目录中
weight: #必需；根据层级使用正确的权重
description: #必需；一句话描述文章内容
---

<!--
在提交 PR 之前，请删除此模板中的所有注释。
-->

<!-- 
H1：Hugo front-matter 中的标题作为文章的 markdown H1。 
-->

<!-- 介绍性段落  
必需。简短的介绍，简要描述快速入门将涵盖的内容。链接到相应的概念或概述文档以提供背景信息。 -->

<!-- 
如果可能，请包含图表或图像。 
-->

<!-- 
确保快速入门包含多种编程语言的示例。 
-->

## 前置条件

<!--
通过列出读者可能需要的内容，确保读者为成功完成快速入门做好准备。
-->

## 步骤 1：设置环境

<!-- 
提供快速入门示例的链接，供读者克隆。 
-->

## 步骤 2：<动作或任务>

<!-- 
每个 H2 步骤应以动词/动作词开头。
-->

<!--
尽可能包含代码片段。 
-->

## 告诉我们您的想法！

我们正在不断努力改进我们的快速入门示例，并重视您的反馈。您觉得这个快速入门有帮助吗？您有改进建议吗？

加入我们的 [discord 频道](https://discord.gg/22ZtJrNe)参与讨论。

<!-- 由于 Dapr 是一个开放的贡献者社区，请确保提供 discord 讨论的链接以欢迎反馈。
-->

## 后续步骤

<!--
链接到相关页面和示例。例如，构建块概述、SDK 快速入门示例的 HTTP 版本等。
-->

<!--
使用按钮 shortcode 引导读者访问更深入的相关场景，例如 Dapr 教程。
-->

3 - How-to 指南模板

创建 how-to 指南的建议模板和指导

贡献新的 how-to 指南

How-to 指南为以下读者提供循序渐进的实践指导：

  • 启用某个功能
  • 集成某项技术
  • 在特定场景中使用 Dapr

与快速入门相比，how-to 指南可以被视为"进阶版"的自引导文档。How-to 场景所需时间更长，且更容易应用到读者的个人项目或环境中。

在命名 how-to 文档时，请在文件名中包含子目录名称。如果需要创建新的子目录，请确保其具有描述性，并包含相关组件或概念名称。例如，pubsub-namespaces。

了解更多关于为 Dapr 文档做贡献的信息，例如 front-matter 和 短代码。

模板

---
type: #Required; docs
title: #Required; "How to: Brief, clear title"
linkTitle: #Required; "How to: Shorter than regular title, to show in table of contents"
weight: #Required; Use the correct weight based on hierarchy
description: #Required; One-sentence description of what to expect in the article
---

<!--
在提交 PR 之前移除此模板中的所有注释。
-->

<!-- 
H1：Hugo front-matter 中的标题作为文章的 markdown H1。 
-->

<!-- 导言段落  
必填。简短的介绍，简要描述 how-to 将涵盖的内容以及任何默认的 Dapr 特性。链接到相应的概念或概述文档以提供背景。-->

<!-- 
如果可能，包含图表或图像。 
-->

<!--
如果适用，在短代码注释或提示中链接到相关的快速入门，例如：

 如果尚未尝试，请先[试用 <主题> 快速入门](link)，以快速了解如何使用 <主题>。

-->

<!-- 
确保 how-to 包含多种编程语言、操作系统或部署目标的示例（如果适用）。 
-->

## <操作或任务>

<!-- 
与快速入门不同，不要使用"步骤 1"、"步骤 2"等。  
-->

## <操作或任务>

<!-- 
每个 H2 步骤应以动词/动作词开头。
-->

-->
尽可能包含代码片段。 
-->

## 下一步

<!--
链接到相关页面和示例。例如，构建块概述、相关教程、API 参考等。
-->