---
title: "内容类型"
description: "每种文档内容类型对应一个指南——它服务的需求、何时使用，以及用智能体搭建页面的命令。"
---

> Documentation Index
> Fetch the complete documentation index at: https://nimbus-docs.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# 内容类型

每个文档页面回答一类读者的问题。Nimbus 为每种内容类型提供了一个**指南（recipe）**：该类型的用途、它*不是*什么、标题语法、质量阈值，以及自查清单。每个指南都是**参考建议，而非门禁**——仅供指导，不会导致构建失败。

这里的每个页面解释一种内容类型。要搭建某种类型的页面，安装其指南——你的编码智能体会读取完整的骨架和清单，并将其适配到你的产品：

```sh
npx add content-how-to
pnpm dlx add content-how-to
yarn dlx add content-how-to
bunx add content-how-to
```

所有示例使用同一个虚构产品：**Hookline**，一个 webhook 投递服务。

| 内容类型 | 读者的问题 | 标志性特征 | 安装 |
|---|---|---|---|
| [概览](/writing/recipes/overview) | "这是什么，我从哪里开始？" | 一段话介绍，然后纯导航 | `content-overview` |
| [快速入门](/writing/recipes/quickstart) | "多快能看到它运行？" | 展示输出；零决策 | `content-quickstart` |
| [教程](/writing/recipes/tutorial) | "教我构建一个真实的东西。" | 每个部分以可见结果结束 | `content-tutorial` |
| [操作指南](/writing/recipes/how-to) | "如何做 X？" | 验证守卫不可逆步骤 | `content-how-to` |
| [概念](/writing/recipes/concept) | "X 到底是什么？" | 定义先行；以边界收尾 | `content-concept` |
| [参考](/writing/recipes/reference) | "确切的值是什么？" | 答案优先的表格；完整或有范围限定 | `content-reference` |
| [示例](/writing/recipes/example) | "给我看 X 的可运行代码。" | 完整且可运行的代码 | `content-example` |
| [故障排除](/writing/recipes/troubleshooting) | "为什么我会看到这个错误？" | 标题使用原始错误信息 | `content-troubleshooting` |
| [变更日志](/writing/recipes/changelog) | "有什么变化——会破坏我的集成吗？" | 破坏性标记开启条目 | `content-changelog` |

在编写新页面时，根据读者的问题来选择类型，而不是根据你想写什么。更多扩展类型（迁移指南、术语表、错误目录……）遵循一个规则：只有当现有指南的契约无法容纳而不断裂时，新类型才值得存在。

Source: https://nimbus-docs.cn/writing/recipes/index.mdx