gutenbergdocs/docs/contributors/documentation/how-to-guide-template.md
2025-10-22 01:40:18 +08:00

1.4 KiB
Raw Blame History

操作指南模板

概述

操作指南通过一系列步骤引导用户完成单个任务。本指南的重点不在于概念教学,而是旨在回答"如何实现..."这一问题。

概述部分需总结问题所在,并可包含正确使用该解决方案的场景和背景信息。

开始之前

需包含前提条件和基本要求说明:

  • 前提条件一WordPress开发环境
  • 前提条件二熟悉JavaScript和Gutenberg编辑器
  • 前提条件三:自定义区块或主题

在此处包含其他重要信息,例如已知问题或程序缺陷。

分步指南

本指南应包含循序渐进的指导说明。可使用代码片段、图片或截图辅助说明每个步骤。根据实际需要设置步骤数量,尽量保持每个步骤简洁明了。

步骤一:[可选标题]

阐述第一步操作的简要说明。

步骤二:[可选标题]

有序列表的引导语句:

  1. 子步骤A
  2. 子步骤B
  3. 子步骤C

步骤三:[可选标题]

代码片段的解释说明。例如:

npm install
npm run build

故障排除

  • 可能出现哪些问题?
  • 潜在错误信息及应对措施?

结语

总结已完成的步骤,说明用户达成的目标。可附上相关文章链接、更复杂的示例,或提供深入学习的途径。