跳到主要内容

一篇教程应该包含什么

本站推荐每篇教程都包含以下部分。不是每一篇都必须完全一样,但结构越稳定,读者越容易复现。

推荐结构

---
title: 教程标题
description: 一句话说明读者能完成什么
tags: [topic, tool]
---

# 教程标题

## 适合谁

## 准备工作

## 操作步骤

## 验证结果

## 常见问题

## 下一步

写作原则

  • 标题写结果,不写情绪。
  • 每一步都尽量给出“完成后应该看到什么”。
  • 截图用于定位关键界面,不要把整篇教程变成截图堆叠。
  • 命令和配置使用代码块,避免混在自然段里。
  • 如果教程依赖第三方平台,写清楚操作日期和版本。

什么时候用 MDX

普通教程优先使用 .md。只有需要嵌入 React 组件、交互示例或复杂展示时,再使用 .mdx