跳转到内容
搜索文档

上下文

最后更新 查看 MarkdownAgent 设置

定义

紧跟在页面标题后面的引导段落,说明用户可以从接下来的内容中期待什么,无论是步骤、概念、常见问题解答(FAQ)还是参考资料。

适用于

操作指南配置常见问题解答概念参考教程

结构

操作指南

针对后续步骤以及这些步骤将实现什么目标的引导段落。

为读者提供章节标题中未包含的原有上下文。

以冒号或句号结尾。

如果其后紧跟步骤,请使用冒号。

如果在上下文和程序之间还有其他内容(例如注释),请使用句号。

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

配置

上下文应在标题后的段落中给出。它应该介绍功能,说明用户将遇到什么类型的配置,并链接到其他相关文档。

常见问题解答

关于该章节以及用户可以从中期待什么的引导段落。

概念

简要描述用户为什么要关注这些信息。

参考

提供引导段落以解释用户如何以及为什么要使用此页面上的信息。

教程

针对用户的目标或待办任务(job-to-be-done)以及他们如何在教程中完成该目标的引导段落。考虑在其中加入教程的适用对象。

这篇文档对您有帮助吗?