document-writer

Nuxt 生态系统文档编写指南

遵循 Nuxt 官方网站的模式编写博客文章和文档的指南。

适用场景

• 为 Nuxt 生态系统项目撰写博客文章
• 创建或编辑文档页面
• 确保内容的写作风格一致

写作规范

例外规则：编写文档时，请保持语法正确，并使用完整的句子。此处不适用“为简洁而牺牲语法”的规则。

文档必须：

• 语法正确
• 清晰明确
• 标点使用得当
• 使用完整的句子（而非残句）

仍应追求简洁，但绝不能以牺牲清晰度或准确性为代价。

相关技能

有关组件和语法的详细信息，请使用以下技能：

技能	用途
nuxt-content	MDC 语法、行文组件、代码高亮
nuxt-ui	组件属性、主题设置、UI 模式

可用参考资料

参考资料	用途
references/writing-style.md	语态、语气、句子结构
references/content-patterns.md	博客 frontmatter、结构、组件模式

加载文件

请根据任务考虑加载以下参考文件：

• references/writing-style.md - 撰写正文、改善语态或语气，或组织句子时使用
• references/content-patterns.md - 创建博客文章、设置 frontmatter 或使用 MDC 组件时使用

不要一次性加载所有文件。 只加载当前任务相关的文件。

快速参考

写作模式

模式	示例
主语优先	“useFetch 组合式函数负责获取数据。”
祈使句	“将以下内容添加到 nuxt.config.ts。”
提供上下文	“使用身份验证时，请进行如下配置……”

情态动词

动词	含义
can	可选
should	建议
must	必须

组件模式（使用时机）

需求	组件
补充信息	::note
建议	::tip
注意事项	::warning
必需事项	::important
行动号召	:u-button{to="..." label="..."}
多来源代码	::code-group

有关组件属性，请参阅 nuxt-ui 技能

标题

• H1（#）：不要使用反引号，否则无法正确渲染
• H2-H4：可以使用反引号

工作流

1. 加载相关参考文件（正文请使用 writing-style.md，结构请使用 content-patterns.md）
2. 使用主动语态和现在时起草内容
3. 应用下方清单检查质量——如果有任何一项未通过，请修改并重新检查
4. 确认提示框类型符合意图（note/tip/warning/important）

示例

# Getting Started with Authentication

Nuxt Better Auth provides a simple way to add authentication to your application.
Configure the module in your `nuxt.config.ts` to get started.

::note
Authentication requires a database connection. See the [database setup](/docs/database) guide for details.
::

## Installation

Add the module to your project:

~~~bash [Terminal]
pnpm add @nuxtjs/better-auth
~~~

The module auto-imports the `useUserSession` composable. Access the current user session from any component.

检查清单

• 使用主动语态（占比 85% 以上）
• 使用现在时
• 每段 2-4 句
• 先解释，再给出代码
• 为代码块标注文件路径
• 使用恰当的提示框类型
• H1 标题中不使用反引号