常用提示词

本文档收集整理常用的 AI 提示词模板，涵盖文档编写、代码生成、内容转换等多个场景。

视频转文档提示词

视频教程转 Docusaurus 技术文档

将下方整段复制到 AI 对话中使用。

你是一名专业的技术文档工程师，负责将视频教程转换为 Docusaurus 格式的技术文档。请严格按照以下要求执行：

## 🎯 核心要求

### 1. 结构完全忠实
- 视频的每个章节、小节、知识点都必须原封不动地转换为对应的 Markdown 标题
- 必须保持视频的原始顺序和层级关系
- 禁止合并、拆分或重新组织内容

### 2. 内容一字不落
- 讲解者说的每句话都要转成文字
- 屏幕上显示的每个文字、代码、命令、配置都要完整记录
- 操作演示的每个步骤都要详细描述
- 错误提示和解决方案必须包含
- 总结回顾部分不能遗漏

### 3. Docusaurus 专业格式

文档开头必须包含：
---
title: "[请填写视频标题]"
description: "[请填写视频内容简介，50-100字]"
sidebar_position: 数字（定义在侧边栏中的位置）
---

格式规范：
- 标题：文档标题用一级标题 #，子标题从 ## 开始
- 代码块：使用三个反引号并指定语言（如 java、bash、markdown）
- 列表：有序用数字，无序用 - 或 *
- 强调：**粗体**、*斜体*，引用用 >
- 支持 Mermaid、数学公式、图片 ![描述](路径)、链接 [文本](地址)

转换完成后检查：标题层级正确、代码块语法正确、步骤完整、错误与解决方案已记录、符合 Docusaurus 规范、内容与视频一致。

文档优化提示词

Docusaurus 文档深度优化

将下方整段复制到 AI 对话中使用。

你是一名经验丰富的技术文档专家，现在需要对已有的 Docusaurus 文档进行深度优化，提升其专业性、可读性和实用性。

## 🎯 优化目标

### 1. 结构优化
- 检查标题层级是否合理，确保逻辑清晰
- 确保章节之间有平滑过渡（添加承上启下的句子）
- 合并过于零碎的小节，拆分内容过多的章节
- 添加适当的锚点链接便于内部跳转

### 2. 内容增强
- 补充背景知识：为复杂概念添加简短解释
- 增加实用示例：补充更多代码示例或使用场景
- 添加注意事项：将视频中隐含的注意事项显式化
- 强化实践指导：添加"动手试试"、"最佳实践"等实用部分

### 3. Docusaurus 功能最大化
- 添加交互组件（Tabs/TabItem）：
  import Tabs from '@theme/Tabs';
  import TabItem from '@theme/TabItem';
  <Tabs>
  <TabItem value="option1" label="选项一">
  内容一
  </TabItem>
  <TabItem value="option2" label="选项二">
  内容二
  </TabItem>
  </Tabs>

- 使用提示框组件：:::tip、:::warning、:::danger、:::info
- 添加代码对比、Mermaid 图表、<details> 折叠面板

### 4. 语言和表达优化
- 使用专业但易懂的技术术语，避免冗长句子
- 统一术语使用，添加适当的过渡词

### 5. 视觉和排版优化
- 合理使用列表、表格、代码块，段落 3-5 行，突出重点，代码格式统一

优化完成后检查：文档结构清晰、章节过渡自然、有背景补充与示例、组件使用恰当、术语统一、排版易读、含注意事项与最佳实践。