Doc Learner

文档学习与内容模仿技能

概述

本技能提供了一套系统化的文档学习和内容模仿方法，能够深入分析各类文档的结构特征、写作风格和表达模式，帮助用户基于优秀范例创建高质量的内容。

工作流程

阶段 1：文档接收与分类

当用户请求学习文档时，首先识别文档类型和目标：

支持的文档类型：

• 提示词（Prompt Engineering）
• 技术文档（Technical Documentation）
• API 文档
• 用户手册
• 产品说明
• 其他结构化文档

确认学习目标：

• 用户想要模仿什么？（结构、风格、格式、内容模式）
• 最终要生成什么内容？（提示词、文档、模板）

阶段 2：深度文档分析

对提供的文档进行多维度分析：

2.1 结构分析

• 文档组织方式（层次结构、章节划分）
• 信息架构（逻辑流程、内容组块）
• 模块化程度（可重用组件、模板化元素）

2.2 风格分析

• 语言风格（正式/非正式、技术/通俗）
• 语气和表达方式（权威、友好、简洁等）
• 术语使用和命名规范

2.3 模式识别

• 句式模式和表达习惯
• 常用句型和过渡词
• 标准化表达和固定搭配

2.4 要素提取

• 关键信息点
• 核心概念和术语
• 必需组成部分

阶段 3：模式提炼与模板创建

基于分析结果创建可重用的模式和模板：

3.1 结构模板

• 文档骨架
• 章节组织框架
• 标准化结构

3.2 写作模式

• 句式模板库
• 表达模式集合
• 风格指南

3.3 关键要素清单

• 必备内容检查表
• 核心要素列表
• 质量标准

阶段 4：内容生成与优化

使用提炼的模式生成新内容：

4.1 内容生成

• 根据用户需求应用学习到的模式
• 填充结构模板
• 应用写作风格

4.2 质量验证

• 检查是否遵循学习到的模式
• 验证结构完整性
• 确保风格一致性

4.3 迭代优化

• 根据用户反馈调整
• 持续改进模板库

核心能力

1. 文档分析引擎

系统能够从多个维度分析文档：

结构维度：

• 识别文档类型和体裁
• 提取组织架构和层次关系
• 分析信息流和逻辑顺序

风格维度：

• 分析语言特征（词汇选择、句式结构）
• 识别语气和表达习惯
• 提取风格标记和特征

模式维度：

• 发现重复出现的表达模式
• 提取可重用的句式和段落
• 识别标准化表达

2. 智能模板提取

自动从文档中提炼可重用元素：

结构模板：

• 文档框架
• 章节模板
• 段落结构

内容模式：

• 句式库
• 表达模式
• 术语集合

风格指南：

• 语言风格规范
• 表达习惯总结
• 最佳实践集合

3. 内容生成支持

基于学习结果辅助创作：

模板化生成：

• 填空式内容创建
• 结构化内容组装
• 模块化内容复用

风格迁移：

• 应用学习到的写作风格
• 模仿表达方式
• 保持风格一致性

质量保证：

• 模式匹配验证
• 结构完整性检查
• 风格一致性评估

使用场景示例

场景 1：学习优秀提示词

用户请求： "我想学习这些优秀提示词的写作方法，然后创建自己的版本"

工作流程： 1. 分析提供的提示词样本 2. 识别提示词结构（角色设定、任务描述、约束条件、输出格式等） 3. 提炼写作模式和技巧 4. 创建提示词模板 5. 帮助用户基于模板生成新提示词

场景 2：模仿技术文档风格

用户请求： "分析这份技术文档的写作风格，帮我写出类似风格的新文档"

工作流程： 1. 分析技术文档的结构和风格 2. 识别文档组织方式 3. 提炼术语使用规范 4. 创建风格指南和模板 5. 指导用户生成新文档

场景 3：文档质量提升

用户请求： "根据优秀文档范例，改进我的文档质量"

工作流程： 1. 对比分析优秀范例和用户文档 2. 识别差距和改进点 3. 应用优秀范例的模式 4. 优化用户文档 5. 提供改进建议

参考资料

references/prompt_analysis_guide.md

提示词分析框架和方法论，包含：

• 提示词结构分析模型
• 常见提示词模式分类
• 提示词质量评估标准
• 最佳实践案例

何时使用： 当需要深度分析提示词结构或学习提示词工程技巧时。

references/tech_doc_patterns.md

技术文档写作模式和模板，包含：

• 技术文档标准结构
• 常用表达模式和句式
• 术语使用规范
• 格式和样式指南

何时使用： 当需要分析或生成技术文档时。

references/style_analysis_framework.md

文档风格分析框架，包含：

• 风格维度分析模型
• 语言特征识别方法
• 风格迁移技巧
• 一致性保持策略

何时使用： 当需要深度分析文档风格或进行风格模仿时。

资产文件

assets/prompts/

提示词模板集合，包含各种类型的提示词模板：

• 角色设定模板
• 任务描述模板
• 约束条件模板
• 输出格式模板

assets/doc_templates/

文档模板集合，包含：

• 技术文档模板
• API 文档模板
• 用户手册模板
• 其他文档类型模板

最佳实践

1. 多样本学习

• 尽量收集多个同类型文档进行学习
• 识别共性模式和个性特征
• 提炼最稳定、最有效的模式

2. 模式验证

• 在实际应用中验证学习到的模式
• 根据效果调整和优化
• 持续改进模板库

3. 灵活应用

• 不要机械套用模板
• 根据具体需求灵活调整
• 保持创造性思维

4. 质量优先

• 注重内容质量而非形式模仿
• 确保生成的内容有价值
• 避免为了模仿而模仿

常见问题

Q: 学习多少个文档样本比较合适？ A: 建议 3-10 个高质量样本。太少可能导致模式不准确，太多可能增加分析复杂度。

Q: 如何处理不同风格的文档？ A: 可以分别学习不同风格，创建多个风格模板，根据需要选择应用。

Q: 生成的内容是否完全模仿原文？ A: 不是。本技能帮助学习和应用优秀文档的模式和结构，但内容本身应该是原创的。

Q: 能否学习非中文文档？ A: 可以。本技能支持多语言文档的学习和模仿。

技术文档模板

概述

本文档提供了一套标准的技术文档模板，适用于各类技术文档的创建。

通用技术文档模板

# [文档标题]

## 概述

[简要说明文档的内容、目的和适用范围]

### 文档信息
- **版本：** [版本号]
- **更新日期：** [日期]
- **作者：** [作者/团队]
- **状态：** [草稿/评审中/已发布]

### 读者对象
本文档适用于：
- [目标读者 1]
- [目标读者 2]

### 前置条件
阅读本文档前，您应该：
- [前置知识 1]
- [前置知识 2]

## 背景

[提供相关背景信息，帮助读者理解上下文]

### 问题域
[描述要解决的问题或需求]

### 相关概念
[介绍关键概念和术语]

## 核心内容

### [章节 1：主题 1]

[内容描述]

#### [小节 1.1]
[详细内容]

#### [小节 1.2]
[详细内容]

### [章节 2：主题 2]

[内容描述]

#### [小节 2.1]
[详细内容]

#### [小节 2.2]
[详细内容]

## 实践指南

### 使用方法

[步骤说明]

1. [步骤 1]
2. [步骤 2]
3. [步骤 3]

### 代码示例

\```[编程语言]
// 代码示例
[示例代码]
\```

### 最佳实践

- [最佳实践 1]
- [最佳实践 2]
- [最佳实践 3]

### 注意事项

> **注意：** [重要提醒]

> **警告：** [警告信息]

## 常见问题

### Q: [常见问题 1]？

**A:** [答案]

### Q: [常见问题 2]？

**A:** [答案]

## 故障排除

### 问题 1：[问题描述]

**症状：** [问题表现]

**原因：** [可能原因]

**解决方案：** [解决步骤]

### 问题 2：[问题描述]

**症状：** [问题表现]

**原因：** [可能原因]

**解决方案：** [解决步骤]

## 参考资料

### 相关文档
- [相关文档 1](链接)
- [相关文档 2](链接)

### 延伸阅读
- [资源 1](链接)
- [资源 2](链接)

### 参考规范
- [规范名称](链接)

## 附录

### 术语表

| 术语 | 定义 |
|------|------|
| [术语 1] | [定义] |
| [术语 2] | [定义] |

### 变更历史

| 版本 | 日期 | 作者 | 变更说明 |
|------|------|------|----------|
| 1.0.0 | [日期] | [作者] | 初始版本 |
| 1.1.0 | [日期] | [作者] | [变更说明] |

---

**文档结束**

API 文档模板

# [API 名称] API 文档

## 概述

[API 简要描述]

### 基本信息
- **版本：** [API 版本]
- **基础 URL：** `https://api.example.com/v[版本号]`
- **认证方式：** [认证类型]

### 功能说明
[描述 API 的主要功能和用途]

## 认证

### 获取凭证

[说明如何获取 API 凭证]

### 使用凭证

\```http
Authorization: Bearer [your-token]
\```

## API 端点

### 1. [端点名称]

#### 描述
[端点功能描述]

#### 请求信息

**方法：** `[GET/POST/PUT/DELETE]`

**端点：** `/path/to/endpoint`

**认证：** 是/否

#### 请求参数

##### Query 参数

| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|--------|------|------|--------|------|
| param1 | string | 是 | - | [参数说明] |
| param2 | number | 否 | 10 | [参数说明] |

##### Body 参数（如适用）

\```json
{
  "field1": "value1",
  "field2": "value2"
}
\```

| 字段名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| field1 | string | 是 | [字段说明] |
| field2 | number | 否 | [字段说明] |

#### 请求示例

\```http
[METHOD] /path/to/endpoint?param1=value1
Host: api.example.com
Authorization: Bearer [your-token]
Content-Type: application/json

{
  "field1": "value1",
  "field2": "value2"
}
\```

#### 响应格式

##### 成功响应

**状态码：** `200 OK`

\```json
{
  "code": 200,
  "message": "success",
  "data": {
    "result": "data"
  }
}
\```

| 字段名 | 类型 | 说明 |
|--------|------|------|
| code | number | 响应状态码 |
| message | string | 响应消息 |
| data | object | 响应数据 |

##### 错误响应

**状态码：** `400 Bad Request`

\```json
{
  "code": 400,
  "message": "error message",
  "errors": [
    {
      "field": "param1",
      "message": "error detail"
    }
  ]
}
\```

#### 使用示例

\```javascript
// JavaScript 示例
const response = await fetch('/path/to/endpoint?param1=value1', {
  method: '[METHOD]',
  headers: {
    'Authorization': 'Bearer [your-token]',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    field1: 'value1',
    field2: 'value2'
  })
});

const data = await response.json();
console.log(data);
\```

### 2. [端点名称]

[重复上述结构]

## 错误码

### 错误码列表

| 错误码 | HTTP 状态码 | 说明 |
|--------|------------|------|
| 400 | 400 | 请求参数错误 |
| 401 | 401 | 未授权 |
| 403 | 403 | 禁止访问 |
| 404 | 404 | 资源不存在 |
| 500 | 500 | 服务器内部错误 |

### 错误处理

[说明如何处理错误]

## 限制和配额

### 请求限制
- 速率限制：[说明]
- 配额限制：[说明]

### 数据限制
- 请求大小限制：[说明]
- 响应大小限制：[说明]

## 最佳实践

### 性能优化
- [优化建议 1]
- [优化建议 2]

### 安全建议
- [安全建议 1]
- [安全建议 2]

## SDK 和库

### 官方 SDK
- [JavaScript SDK](链接)
- [Python SDK](链接)
- [Java SDK](链接)

### 社区库
- [社区库 1](链接)
- [社区库 2](链接)

## 变更日志

### [版本号] - [日期]
- [变更 1]
- [变更 2]

### [版本号] - [日期]
- [变更 1]
- [变更 2]

## 支持

如有问题，请通过以下方式联系我们：
- 邮箱：support@example.com
- 论坛：[论坛链接]
- 问题追踪：[Issue 链接]

用户手册模板

# [产品/功能] 用户手册

## 快速开始

欢迎使用 [产品/功能]！本指南将帮助您快速上手。

### 系统要求

- [要求 1]
- [要求 2]

### 安装步骤

1. [步骤 1]
2. [步骤 2]
3. [步骤 3]

### 首次配置

[说明首次配置步骤]

## 功能介绍

### 功能 1：[功能名称]

#### 功能概述
[简要说明功能]

#### 使用场景
- [场景 1]
- [场景 2]

#### 操作步骤

1. **[步骤标题]**

   [详细说明]

2. **[步骤标题]**

   [详细说明]

#### 示例

\```[格式]
[示例内容]
\```

#### 注意事项

> 💡 **提示：** [有用提示]

### 功能 2：[功能名称]

[重复上述结构]

## 操作指南

### 常规操作流程

[描述常规操作流程]

### 高级功能使用

[介绍高级功能]

### 配置说明

[说明配置选项]

| 配置项 | 说明 | 默认值 |
|--------|------|--------|
| [配置 1] | [说明] | [默认值] |
| [配置 2] | [说明] | [默认值] |

## 最佳实践

### 使用建议

1. [建议 1]
2. [建议 2]
3. [建议 3]

### 性能优化

[优化建议]

### 安全建议

[安全建议]

## 常见问题

### 安装和配置

**Q: [问题]？**

**A:** [答案]

### 使用和操作

**Q: [问题]？**

**A:** [答案]

### 性能和错误

**Q: [问题]？**

**A:** [答案]

## 故障排除

### 问题诊断

[诊断步骤]

### 常见错误

#### 错误 1：[错误名称]

**症状：**
- [症状 1]
- [症状 2]

**解决方案：**
1. [解决步骤 1]
2. [解决步骤 2]

#### 错误 2：[错误名称]

[重复上述结构]

### 获取帮助

如果问题仍未解决：
- 查看知识库：[链接]
- 提交工单：[链接]
- 联系支持：support@example.com

## 附录

### 键盘快捷键

| 快捷键 | 功能 |
|--------|------|
| [快捷键] | [功能] |
| [快捷键] | [功能] |

### 文件格式

[说明支持的文件格式]

### 版本历史

| 版本 | 日期 | 变更说明 |
|------|------|----------|
| 1.0.0 | [日期] | 初始版本 |
| 1.1.0 | [日期] | [变更] |

---

**感谢使用 [产品/功能]！**

使用指南

选择合适的模板

1. 通用技术文档：适用于大多数技术文档 2. API 文档：专门用于 API 接口文档 3. 用户手册：面向最终用户的操作指南

自定义模板

根据具体需求，可以：

• 调整章节顺序
• 添加或删除章节
• 修改内容结构
• 更新格式样式

模板最佳实践

1. 保持一致性：在整个文档中使用统一的格式和风格 2. 明确受众：根据目标读者调整内容深度和表达方式 3. 提供示例：包含实用的代码示例和使用场景 4. 定期更新：保持文档与产品功能同步更新 5. 收集反馈：根据用户反馈持续改进文档

格式规范

标题层级

• 一级标题（#）：文档标题
• 二级标题（##）：主要章节
• 三级标题（###）：子章节
• 四级标题（####）：细节说明

代码块

• 使用三个反引号包裹代码
• 指定编程语言
• 添加必要的注释

表格

• 使用标准 Markdown 表格格式
• 包含表头
• 对齐方式一致

强调

• 加粗：重要内容
• 斜体：术语或强调
• 代码：技术术语或代码

列表

• 无序列表：使用 -
• 有序列表：使用数字
• 任务列表：使用 - [ ]

引用

• 使用 > 引用重要信息
• 可以添加表情符号增强视觉效果
• 💡 提示
• ⚠️ 警告
• ❗ 重要
• ✅ 成功
• ❌ 错误

角色设定型提示词模板

基础模板

# 角色设定

你是一位 [角色名称]，具有以下专业能力：
- [专业能力 1]
- [专业能力 2]
- [专业能力 3]

你的工作经历包括 [相关工作经历]，对 [领域/行业] 有深入的理解。

# 任务描述

你的任务是 [明确说明要完成的任务]。

具体要求：
1. [要求 1]
2. [要求 2]
3. [要求 3]

# 约束条件

在完成任务时，请遵守以下约束：
- [约束 1]
- [约束 2]
- [约束 3]

# 输出格式

请以 [指定格式] 的形式输出结果，包含以下部分：
- [输出部分 1]
- [输出部分 2]
- [输出部分 3]

# 注意事项

- [注意事项 1]
- [注意事项 2]

请开始执行任务。

高级模板

## 角色定位

你是一位资深的 [职位/角色]，专注于 [专业领域]，拥有 [年数] 年的行业经验。

### 核心能力
1. [核心技能 1]：[详细说明]
2. [核心技能 2]：[详细说明]
3. [核心技能 3]：[详细说明]

### 工作方法
你的工作风格是 [描述工作风格]，通常采用 [方法论/框架] 来解决问题。

## 任务背景

[提供任务背景信息，帮助理解任务的重要性和上下文]

## 核心任务

### 主任务
[描述主要任务]

### 子任务
1. [子任务 1]
2. [子任务 2]
3. [子任务 3]

## 执行标准

### 质量标准
- [质量要求 1]
- [质量要求 2]

### 时间要求
- [时间约束]

### 资源限制
- [可用资源]
- [限制条件]

## 交付成果

### 必需内容
1. [内容 1]
2. [内容 2]
3. [内容 3]

### 可选内容
1. [内容 1]
2. [内容 2]

## 输出规范

### 格式要求
- [格式要求 1]
- [格式要求 2]

### 结构要求
- [结构要求 1]
- [结构要求 2]

### 风格要求
- [风格要求 1]
- [风格要求 2]

## 评估指标

任务完成情况将根据以下指标评估：
1. [指标 1]
2. [指标 2]
3. [指标 3]

---

现在请按照上述要求完成任务。

快速模板

# 角色
你是一位 [角色]。

# 任务
请 [简要描述任务]。

# 要求
- [要求 1]
- [要求 2]

# 输出
[期望的输出格式]

使用示例

示例 1：代码审查专家

# 角色设定

你是一位资深代码审查专家，具有以下专业能力：
- 精通多种编程语言（JavaScript、Python、Java、Go）
- 熟悉设计模式和最佳实践
- 擅长识别代码中的安全漏洞和性能问题

你的工作经历包括 10 年以上的软件开发和团队管理经验，曾为多个大型开源项目贡献代码。

# 任务描述

你的任务是审查以下代码，并提供详细的反馈意见。

具体要求：
1. 识别代码中的问题和潜在风险
2. 提供改进建议和最佳实践
3. 评估代码的可读性和可维护性

# 约束条件

在完成任务时，请遵守以下约束：
- 保持客观、建设性的态度
- 提供具体、可操作的建议
- 考虑代码的实际应用场景

# 输出格式

请以结构化的报告形式输出结果，包含以下部分：
- 代码概览
- 发现的问题（按严重程度分类）
- 改进建议（优先级排序）
- 优点总结

# 注意事项

- 既要指出问题，也要肯定优点
- 建议应该具体、可执行
- 考虑代码的实际运行环境

请开始执行任务。

[待审查的代码]

示例 2：技术文档撰写专家

# 角色设定

你是一位专业的技术文档撰写专家，擅长创建清晰、准确、易读的技术文档。

核心能力：
- 精通技术文档写作规范和最佳实践
- 能够将复杂的技术概念转化为通俗易懂的内容
- 熟悉多种文档类型（API 文档、用户手册、开发指南等）

# 任务描述

你的任务是为一项新的技术功能撰写用户文档。

具体要求：
1. 清晰说明功能的工作原理
2. 提供详细的使用步骤
3. 包含实用的代码示例

# 约束条件

在完成任务时，请遵守以下约束：
- 使用简洁、准确的语言
- 假设读者具有基本的技术背景
- 避免使用未经解释的专业术语

# 输出格式

请以标准技术文档的格式输出，包含以下部分：
- 功能概述
- 前置条件
- 使用指南
- 代码示例
- 常见问题

# 注意事项

- 确保内容的准确性和完整性
- 使用适当的格式和排版
- 考虑不同技能水平的读者

请开始执行任务。

[技术功能说明]

模板使用指南

选择合适的模板

1. 基础模板：适合简单任务，快速创建提示词 2. 高级模板：适合复杂任务，需要详细的角色设定和约束 3. 快速模板：适合日常使用，轻量级提示词

自定义模板

根据具体需求，可以调整以下要素：

角色设定：

• 调整角色的专业领域
• 修改核心能力描述
• 更新工作经历

任务描述：

• 明确主任务和子任务
• 添加任务背景信息
• 定义成功标准

约束条件：

• 添加必要的约束
• 设置优先级
• 定义边界条件

输出格式：

• 选择合适的输出格式
• 定义输出结构
• 指定内容要求

最佳实践

1. 角色具体化：使用具体的角色名称和专业领域 2. 任务明确化：清晰定义任务的目标和范围 3. 约束合理化：设置合理、可达成的约束条件 4. 输出结构化：要求输出结构化、易于理解的结果 5. 示例丰富化：提供多个不同领域的示例

常见角色类型

技术类

• 代码审查专家
• 架构设计专家
• 性能优化专家
• 安全专家
• 测试专家

内容类

• 技术文档撰写专家
• 教程创作专家
• 内容编辑
• 翻译专家

分析类

• 数据分析师
• 业务分析师
• 市场研究专家
• 用户研究员

创意类

• UI/UX 设计师
• 创意文案
• 品牌策划
• 产品经理

提示词分析框架与方法论

概述

本文档提供了一套系统化的提示词分析框架，帮助深度理解优秀提示词的结构、模式和最佳实践。

提示词结构分析模型

CO-STAR 框架

一个优秀的提示词通常包含以下核心要素：

C - Context（背景）

• 提供必要的背景信息
• 设定场景和前提
• 建立共同理解

O - Objective（目标）

• 明确要完成的任务
• 定义成功标准
• 设定期望结果

S - Style（风格）

• 指定输出风格
• 设定语气和语调
• 定义表达方式

T - Tone（语气）

• 专业/非正式
• 友好/权威
• 简洁/详细

A - Audience（受众）

• 谁将使用输出
• 受众的知识水平
• 受众的期望和需求

R - Response Format（响应格式）

• 输出结构
• 格式要求
• 具体呈现方式

常见提示词结构模式

模式 1：角色设定型

# 角色设定
你是一位[具体角色]，具有[专业能力]。

# 任务描述
你的任务是[具体任务]。

# 约束条件
- [约束1]
- [约束2]

# 输出要求
以[格式]形式输出，包含[具体要素]。

模式 2：分步骤指导型

## 任务目标
[简要说明目标]

## 执行步骤
1. [第一步]
2. [第二步]
3. [第三步]

## 注意事项
- [注意事项1]
- [注意事项2]

## 预期输出
[描述预期输出]

模式 3：示例驱动型

# 任务说明
[说明要做什么]

# 示例

## 示例 1
输入：[示例输入]
输出：[示例输出]

## 示例 2
输入：[示例输入]
输出：[示例输出]

# 你的任务
[根据上述示例完成类似任务]

提示词模式分类

按功能分类

1. 信息提取类

• 从文本中提取特定信息
• 结构化数据提取
• 关键要素识别

2. 内容生成类

• 文档写作
• 创意内容
• 技术文档

3. 分析推理类

• 数据分析
• 逻辑推理
• 问题解决

4. 转换处理类

• 格式转换
• 语言翻译
• 风格调整

5. 评估判断类

• 质量评估
• 内容审核
• 方案比较

按复杂度分类

1. 简单提示词

• 单一任务
• 直接指令
• 明确输出

2. 复合提示词

• 多个相关任务
• 分步骤执行
• 依赖关系

3. 复杂提示词

• 多阶段处理
• 条件分支
• 迭代优化

提示词质量评估标准

完整性检查

• [ ] 是否有明确的角色设定
• [ ] 是否有清晰的任务描述
• [ ] 是否有必要的约束条件
• [ ] 是否有具体的输出格式
• [ ] 是否有必要的上下文信息

清晰性评估

• [ ] 指令是否无歧义
• [ ] 术语是否统一
• [ ] 逻辑是否连贯
• [ ] 表达是否简洁

可执行性判断

• [ ] 任务是否具体可行
• [ ] 约束是否合理
• [ ] 资源是否充足
• [ ] 标准是否明确

最佳实践案例

案例 1：代码生成提示词

优秀特征：

• 明确了技术栈
• 指定了代码规范
• 提供了接口定义
• 说明了使用场景

案例 2：文档写作提示词

优秀特征：

• 定义了目标读者
• 设定了内容结构
• 指定了写作风格
• 提供了参考资料

案例 3：问题解决提示词

优秀特征：

• 描述了问题背景
• 分析了可能原因
• 提供了解决方案框架
• 定义了评估标准

常见错误模式

错误 1：信息不足

问题： 缺少必要的背景或约束

解决： 补充上下文、添加约束条件

错误 2：指令模糊

问题： 任务描述不清晰，有多种理解

解决： 使用更精确的语言、提供示例

错误 3：过度复杂

问题： 包含过多不必要的信息

解决： 精简内容、聚焦核心任务

错误 4：缺少反馈机制

问题： 无法验证输出质量

解决： 添加评估标准、提供验证方法

提示词优化技巧

渐进式优化

1. 基础版本：实现核心功能 2. 增强版本：添加约束和细节 3. 优化版本：改进表达和结构 4. 完美版本：验证和迭代

A/B 测试

• 创建多个版本
• 对比实际效果
• 选择最优方案
• 持续改进

模式复用

• 识别有效模式
• 提取可复用元素
• 建立模板库
• 快速应用

分析方法

结构化分析步骤

1. 初步浏览

• 快速扫描全文
• 识别主要部分
• 理解整体结构

2. 详细拆解

• 分段分析内容
• 识别关键要素
• 记录重要特征

3. 模式提取

• 总结结构模式
• 提炼表达方式
• 归纳最佳实践

4. 质量评估

• 评估完整性
• 判断清晰度
• 验证可执行性

5. 改进建议

• 识别改进点
• 提出优化方案
• 创建优化版本

快速参考

关键问题清单

分析提示词时，始终问自己：

1. 这个提示词要做什么？ 2. 目标是什么？ 3. 提供了哪些信息？ 4. 有哪些约束条件？ 5. 期望什么样的输出？ 6. 结构是否清晰？ 7. 表达是否准确？ 8. 是否有改进空间？

分析模板

## 基本信息
- 提示词类型：
- 主要任务：
- 目标受众：

## 结构分析
- 角色设定：
- 任务描述：
- 约束条件：
- 输出格式：

## 质量评估
- 完整性：
- 清晰性：
- 可执行性：

## 模式特征
- 使用的主要模式：
- 表达特征：
- 风格特点：

## 改进建议
- 优点：
- 待改进：
- 优化方向：

文档风格分析框架

概述

本文档提供了一套系统化的文档风格分析框架，用于识别、理解和模仿各类文档的写作风格，确保生成内容的一致性和专业性。

风格维度分析模型

1. 语言维度

1.1 词汇选择

词汇复杂度：

• 简单词汇： 使用日常、普及的词汇
• 示例："使用"、"帮助"、"简单"
• 专业术语： 使用领域特定术语
• 示例："实例化"、"封装"、"异步"
• 学术词汇： 使用正式、学术性词汇
• 示例："基于"、"通过"、"实现"

词汇密度：

• 低密度： 使用简单的单词表达
• "帮助用户完成任务"
• 高密度： 使用更多的名词化表达
• "协助用户实现任务目标"

术语使用模式：

• 术语频率（专业术语出现频率）
• 术语解释习惯（首次出现是否解释）
• 缩写使用（是否使用缩写及缩写规则）

1.2 句式结构

句子长度：

• 短句： 10 字以下
• "点击按钮。"
• 中句： 10-30 字
• "点击页面上的按钮，开始下载过程。"
• 长句： 30 字以上
• "点击页面右上角的下载按钮，系统将自动开始下载安装程序到您的本地设备。"

句式多样性：

• 简单句："系统支持这个功能。"
• 并列句："系统支持这个功能，并提供配置选项。"
• 复合句："当系统检测到新数据时，会自动触发同步流程，并更新本地缓存。"

句子结构：

• 主动语态 vs 被动语态
• 陈述句 vs 祈使句 vs 疑问句
• 倒装句 vs 正常语序

1.3 语气特征

语气类型：

• 客观中性： 事实陈述，无情感色彩
• "系统版本为 1.0.0"
• 专业权威： 专业知识，可信度高
• "根据最佳实践，建议..."
• 友好亲和： 接近口语，易于理解
• "让我们来学习如何..."
• 简洁直接： 简练表达，直击要点
• "点击确定。"

语气标记：

• 使用的副词和形容词
• 情感词汇的使用
• 修饰语的使用频率

2. 结构维度

2.1 组织模式

层次结构：

• 扁平结构： 少量层级，信息平铺
• 标题 → 内容
• 层次结构： 多级标题，详细分类
• 标题 → 章节 → 小节 → 要点

信息流：

• 线性： 按时间或步骤顺序
• 层级： 从总体到细节
• 网状： 多维度关联

段落组织：

• 段落长度（字数）
• 段落功能（引入、展开、总结）
• 段落过渡方式

2.2 章节划分

标题风格：

• 名词性标题："系统架构"
• 动词性标题："配置环境"
• 问题性标题："如何部署？"
• 陈述性标题："系统支持的功能"

章节长度：

• 短章节（< 200 字）
• 中等章节（200-500 字）
• 长章节（> 500 字）

2.3 逻辑关系

连接词使用：

• 顺承："首先"、"其次"、"然后"
• 转折："但是"、"然而"、"不过"
• 因果："因此"、"所以"、"由于"
• 递进："此外"、"而且"、"更进一步"

论证方式：

• 归纳：从例子到结论
• 演绎：从原理到应用
• 类比：用比喻说明
• 对比：通过比较突出特点

3. 格式维度

3.1 标点使用

标点偏好：

• 逗号使用频率
• 句号 vs 顿号
• 引号类型（单引号 vs 双引号）
• 破折号使用

特殊符号：

• 项目符号（•、-、*）
• 编号（1.、1)、（1））
• 箭头（→、➜）
• 其他符号（※、▶、▸）

3.2 强调方式

强调手段：

• 加粗： 重点内容
• 斜体： 术语或注释
• 代码： 技术术语
• > 引用：重要说明

强调频率：

• 高频：每段都有强调
• 中频：重要内容强调
• 低频：很少使用强调

3.3 列表使用

列表类型：

• 无序列表
• 有序列表
• 任务列表
• 定义列表

列表深度：

• 单层列表
• 二层列表
• 多层嵌套

4. 内容维度

4.1 详细程度

信息密度：

• 低密度： 详细说明，多处举例
• 中密度： 适度说明，关键处举例
• 高密度： 精炼表达，少举例

细节程度：

• 包含实现细节
• 包含使用场景
• 包含边界情况
• 包含历史背景

4.2 示例使用

示例类型：

• 代码示例
• 场景示例
• 数据示例
• 图表示例

示例呈现：

• 内联示例：嵌入文字中
• 独立示例：单独代码块
• 详细示例：带注释和说明

4.3 参考引用

引用方式：

• 超链接
• 文档引用
• 书籍引用
• 规范引用

引用频率：

• 频繁引用
• 偶尔引用
• 很少引用

风格特征识别方法

步骤 1：整体感知

快速浏览文档，形成初步印象：

问题引导：

• 这是什么类型的文档？
• 给谁看的？
• 什么场景下使用？
• 给人的整体感觉是什么？

记录第一印象：

• 正式/非正式
• 专业/通俗
• 简洁/详细
• 冷淡/友好

步骤 2：系统分析

按照维度模型系统分析：

2.1 语言分析

• 提取关键词汇
• 统计句式类型
• 识别语气特征

2.2 结构分析

• 绘制文档结构图
• 分析章节组织
• 识别逻辑关系

2.3 格式分析

• 记录标点使用
• 统计强调方式
• 分析列表使用

2.4 内容分析

• 评估信息密度
• 统计示例数量
• 检查引用方式

步骤 3：模式提炼

总结风格模式：

核心特征：

• 最显著的风格特点
• 最常用的表达方式
• 最独特的格式习惯

风格标签：

• [ ] 正式/非正式
• [ ] 专业/通俗
• [ ] 简洁/详细
• [ ] 客观/主观
• [ ] 理论/实践
• [ ] 学术/实用

风格示例： 收集典型句子或段落作为风格参考

步骤 4：风格描述

用简洁的语言描述风格：

描述框架：

这是一篇[特征1]、[特征2]的[文档类型]。

语言方面：[描述语言特征]
结构方面：[描述结构特征]
格式方面：[描述格式特征]

整体风格：[总结整体印象]
适用场景：[适用场景和对象]

风格迁移技巧

1. 词汇迁移

词汇替换：

• 简单 → 专业："用" → "使用/调用/执行"
• 专业 → 简单："实例化" → "创建"
• 普通 → 学术："可以" → "支持/允许"

术语统一：

• 识别术语集
• 建立术语映射
• 批量替换

2. 句式迁移

句式转换：

• 短句 → 长句：添加修饰和细节
• 长句 → 短句：拆分简化
• 主动 → 被动：调整语态
• 被动 → 主动：调整语态

句式模仿：

• 分析目标句式结构
• 提取句式模板
• 应用新内容

3. 语气迁移

语气调整：

• 识别语气标记
• 替换语气词汇
• 调整表达方式

示例：

• 客观 → 友好：添加礼貌用语
• 正式 → 非正式：简化表达
• 冷淡 → 热情：添加积极词汇

4. 格式迁移

格式统一：

• 统一标题层级
• 统一标点符号
• 统一列表风格
• 统一强调方式

结构对齐：

• 分析目标结构
• 调整内容顺序
• 添加缺失部分
• 删除冗余内容

一致性保持策略

1. 建立风格指南

创建明确的风格规范：

词汇规范：

• 术语表
• 禁用词列表
• 推荐词列表

句式规范：

• 句长要求
• 句式偏好
• 语态选择

格式规范：

• 标题样式
• 标点使用
• 强调方式

2. 使用模板

创建可复用模板：

结构模板：

• 文档框架
• 章节模板
• 段落模板

句式模板：

• 常用句型
• 固定搭配
• 过渡表达

3. 检查清单

建立一致性检查清单：

语言一致性：

• [ ] 术语使用统一
• [ ] 语气保持一致
• [ ] 句式风格统一

结构一致性：

• [ ] 层级结构统一
• [ ] 章节长度相近
• [ ] 逻辑关系一致

格式一致性：

• [ ] 标题格式统一
• [ ] 标点使用统一
• [ ] 列表风格统一

4. 迭代改进

持续优化一致性：

收集反馈：

• 读者反馈
• 同行评审
• 使用数据

分析问题：

• 识别不一致处
• 分析原因
• 制定改进方案

持续优化：

• 更新风格指南
• 完善模板
• 改进流程

风格对比分析

对比方法

选择对比维度：

• 关键维度对比
• 整体风格对比
• 局部特征对比

制作对比表：

差异总结：

• 主要差异点
• 相似之处
• 适配建议

风格融合

融合策略：

• 保留核心特征
• 借鉴优点
• 形成新风格

融合方法： 1. 分析两种风格 2. 识别兼容点 3. 设计融合方案 4. 验证效果

实用工具

风格分析检查表

## 语言风格
- [ ] 词汇复杂度：简单/中等/专业
- [ ] 句子长度：短句/中句/长句
- [ ] 语气特征：客观/专业/友好/简洁
- [ ] 术语使用：频率、解释习惯

## 结构风格
- [ ] 层次结构：扁平/层次
- [ ] 标题风格：名词/动词/问题
- [ ] 段落组织：长度、过渡

## 格式风格
- [ ] 标点使用：偏好和习惯
- [ ] 强调方式：加粗/斜体/代码
- [ ] 列表使用：类型和深度

## 内容风格
- [ ] 信息密度：低/中/高
- [ ] 示例使用：类型和频率
- [ ] 引用方式：类型和频率

## 整体印象
- [ ] 一句话描述整体风格
- [ ] 三个关键词
- [ ] 适用场景

风格模板示例

模板 1：专业技术风格

## 特征
- 词汇：专业术语为主
- 句式：中等长度，复合句多
- 语气：客观、权威
- 结构：层次清晰，逻辑严密

## 适用场景
- 技术文档
- API 文档
- 开发指南

## 典型表达
- "系统采用...架构"
- "通过...实现..."
- "确保...的一致性"

模板 2：用户友好风格

## 特征
- 词汇：简单、通俗
- 句式：短句为主，主动语态
- 语气：友好、亲切
- 结构：扁平，步骤清晰

## 适用场景
- 用户手册
- 操作指南
- 快速入门

## 典型表达
- "让我们..."
- "您可以..."
- "只需..."

模板 3：简洁实用风格

## 特征
- 词汇：精炼、准确
- 句式：短句、祈使句
- 语气：直接、高效
- 结构：要点式，信息密集

## 适用场景
- 快速参考
- API 参考
- 命令手册

## 典型表达
- "执行..."
- "返回..."
- "参数：..."

常见问题

Q1: 如何处理风格冲突？

A: 优先考虑文档类型和受众，选择最匹配的风格。必要时可以融合多种风格的优点。

Q2: 风格分析需要多深入？

A: 根据需求决定。快速分析关注主要特征，深度分析关注细节和模式。

Q3: 如何确保风格一致性？

A: 建立风格指南，使用模板，定期检查，收集反馈持续改进。

Q4: 可以创新风格吗？

A: 可以。在理解现有风格的基础上，根据具体需求和场景创造性地应用和调整。

技术文档写作模式与模板

概述

本文档总结了技术文档的标准结构、常用表达模式和写作规范，为技术文档的学习和创作提供参考。

技术文档标准结构

通用文档结构

# 文档标题

## 概述
- 简要说明文档内容
- 适用对象
- 前置条件

## 背景/简介
- 相关背景信息
- 问题域说明
- 基本概念

## 核心内容
### 主题 1
### 主题 2
### 主题 3

## 实践指南
- 使用方法
- 示例代码
- 最佳实践

## 常见问题
- FAQ
- 故障排除
- 注意事项

## 参考资料
- 相关链接
- 延伸阅读
- 参考文档

API 文档结构

# API 名称

## 概述
- 功能说明
- 版本信息
- 基础 URL

## 认证
- 认证方式
- 获取凭证
- 使用说明

## 端点列表

### [方法] /path/to/endpoint

**描述：** [简要描述]

**请求参数：**

| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| param1 | string | 是 | 参数说明 |
| param2 | number | 否 | 参数说明 |

**请求示例：**

GET /api/endpoint?param1=value

**响应示例：**

{ "code": 200, "message": "success", "data": {} }

**响应字段：**

| 字段名 | 类型 | 说明 |
|--------|------|------|
| code | number | 状态码 |
| message | string | 响应消息 |
| data | object | 响应数据 |

## 错误码
- 错误码列表
- 错误说明
- 处理建议

用户手册结构

# 产品/功能用户手册

## 快速开始
- 安装指南
- 基本配置
- 第一步操作

## 功能介绍
### 功能 1：名称
- 功能概述
- 使用场景
- 操作步骤

### 功能 2：名称
...

## 操作指南
- 常规操作流程
- 高级功能使用
- 配置说明

## 最佳实践
- 使用建议
- 性能优化
- 注意事项

## 故障排除
- 常见问题
- 解决方案
- 联系支持

常用表达模式

指令性表达

直接命令：

• "点击..."
• "选择..."
• "输入..."
• "执行..."

祈使句：

• "请确保..."
• "务必..."
• "建议..."
• "必须..."

条件指令：

• "如果...，则..."
• "当...时..."
• "在...情况下..."

说明性表达

定义概念：

• "...是指..."
• "...定义为..."
• "...包括..."

描述功能：

• "此功能用于..."
• "该选项允许..."
• "本模块提供..."

解释原因：

• "这是因为..."
• "目的是为了..."
• "这样做的理由是..."

警告性表达

注意事项：

• "注意："
• "警告："
• "重要："
• "切记："

限制说明：

• "不支持..."
• "仅适用于..."
• "限制为..."

风险提示：

• "可能导致..."
• "避免..."
• "请勿..."

术语使用规范

技术术语

一致性原则：

• 同一概念使用统一术语
• 首次出现时给出定义
• 保持术语翻译一致

示例：

• API / Application Programming Interface
• SDK / Software Development Kit
• Endpoint / 端点
• Payload / 负载

操作术语

常用动词：

• 配置（configure）
• 部署（deploy）
• 安装（install）
• 集成（integrate）
• 调用（invoke/call）
• 返回（return）
• 处理（process）
• 验证（validate）

标准搭配：

• 执行命令
• 调用接口
• 返回结果
• 处理数据
• 验证身份

状态术语

常见状态：

• 成功（success）
• 失败（failure）
• 进行中（pending/in progress）
• 已完成（completed）
• 已取消（cancelled）

状态描述：

• "操作成功"
• "执行失败"
• "处理中"
• "已完成"

格式和样式指南

标题层级

# 一级标题（文档标题）
## 二级标题（主要章节）
### 三级标题（子章节）
#### 四级标题（细节说明）

使用原则：

• 层级清晰，逻辑分明
• 不跳级使用
• 同级内容并列

代码块

行内代码： 使用 单个反引号 包裹

代码块： 使用三个反引号包裹，指定语言

\``javascript function example() { // code here } \``

命令行： \``bash npm install package-name \``

强调和重点

加粗强调：

• 重要概念
• 关键步骤

斜体标注：

• 术语定义
• 注意事项

代码字体：

• 使用等宽字体表示变量、参数名

列表使用

无序列表：

• 要点 1
• 要点 2
• 子要点
• 子要点

有序列表： 1. 步骤一 2. 步骤二 3. 步骤三

任务列表：

• [ ] 待完成任务
• [x] 已完成任务

表格格式

| 列 1 | 列 2 | 列 3 |
|------|------|------|
| 数据 | 数据 | 数据 |
| 数据 | 数据 | 数据 |

对齐方式：

写作风格规范

语言风格

技术文档特点：

• 客观、准确
• 简洁、明了
• 逻辑、严谨
• 专业、规范

语言要求：

• 使用简单句
• 避免复杂从句
• 使用主动语态
• 避免歧义表达

时态使用

一般现在时：

• 描述功能特性
• 说明操作步骤
• 解释概念原理

示例：

• "该功能支持..."
• "点击按钮后..."
• "系统会自动..."

人称使用

第二人称（你）：

• 操作指南
• 用户手册
• 教程文档

第三人称（它/系统）：

• 功能描述
• 系统说明
• 技术规范

简洁性原则

避免冗余：

• ❌ "用户可以点击按钮来..."
• ✅ "点击按钮..."

去除废话：

• ❌ "基本上，这个功能是用来..."
• ✅ "该功能用于..."

直接表达：

• ❌ "在这个阶段，我们需要..."
• ✅ "此时..."

最佳实践

1. 受众导向

明确读者：

• 开发者 → 技术细节、代码示例
• 产品经理 → 功能概述、使用场景
• 最终用户 → 操作指南、注意事项

调整深度：

• 根据读者背景调整技术深度
• 提供适当的背景说明
• 使用读者熟悉的术语

2. 结构化组织

层次清晰：

• 使用标题和子标题
• 合理分组相关内容
• 提供目录导航

逻辑连贯：

• 内容顺序符合认知逻辑
• 步骤之间有自然过渡
• 前后有呼应

3. 示例驱动

代码示例：

• 提供完整可运行的示例
• 包含必要的注释
• 展示最佳实践

场景示例：

• 真实使用场景
• 常见用例
• 边界情况

4. 可维护性

版本管理：

• 标注文档版本
• 记录更新历史
• 关联产品版本

易于更新：

• 模块化内容
• 避免重复信息
• 统一格式规范

质量检查清单

内容完整性

• [ ] 概念说明清楚
• [ ] 操作步骤完整
• [ ] 示例代码可用
• [ ] 注意事项提醒
• [ ] 参考资料齐全

结构合理性

• [ ] 逻辑层次清晰
• [ ] 章节划分合理
• [ ] 过渡自然流畅
• [ ] 重点内容突出

表达准确性

• [ ] 术语使用统一
• [ ] 描述准确无误
• [ ] 语言简洁明了
• [ ] 无歧义表达

格式规范性

• [ ] 标题层级正确
• [ ] 代码格式规范
• [ ] 列表使用得当
• [ ] 表格格式统一

可读性

• [ ] 字体大小合适
• [ ] 行距段落舒适
• [ ] 重点内容标注
• [ ] 图文搭配合理

常见问题与解决方案

问题 1：文档过于冗长

原因： 包含过多细节或重复信息

解决：

• 精简表达
• 移除冗余内容
• 使用引用代替重复

问题 2：结构混乱

原因： 缺少整体规划

解决：

• 制定大纲
• 明确章节目标
• 调整内容顺序

问题 3：表达不清晰

原因： 缺少示例或说明

解决：

• 添加示例
• 补充说明
• 使用图示

问题 4：难以维护

原因： 缺少模块化

解决：

• 拆分内容
• 建立引用
• 版本控制

快速参考

文档类型快速模板

快速参考：

## 概述
## 前提条件
## 步骤
1. ...
2. ...
## 示例
## 注意事项

概念文档：

## 概念定义
## 工作原理
## 关键特性
## 使用场景
## 最佳实践

操作指南：

## 目标
## 步骤
### 准备工作
### 执行步骤
### 验证结果
## 故障排除

文档学习与内容模仿

工作流程

1. 文档接收与分类

支持类型： 提示词、技术文档、API文档、用户手册、产品说明、其他结构化文档

确认目标： 模仿什么？（结构/风格/格式/模式）→ 生成什么？（提示词/文档/模板）

2. 深度文档分析

2.1 结构分析： 文档组织、信息架构、模块化程度

2.2 风格分析： 语言风格、语气表达、术语规范

2.3 模式识别： 句式模式、常用句型、标准表达

2.4 要素提取： 关键信息点、核心概念、必需组成部分

3. 模式提炼与模板创建

3.1 结构模板： 文档骨架、章节框架、标准化结构

3.2 写作模式： 句式模板库、表达模式集合、风格指南

3.3 关键要素清单： 必备内容检查表、核心要素列表、质量标准

4. 内容生成与优化

4.1 内容生成： 应用学习模式、填充结构模板、应用写作风格

4.2 质量验证： 检查模式遵循、验证结构完整性、确保风格一致性

4.3 迭代优化： 根据反馈调整、持续改进模板库

核心能力

文档分析引擎（三维度）：

• 结构：识别文档类型、提取组织架构、分析信息流
• 风格：分析语言特征、识别语气、提取风格标记
• 模式：发现表达模式、提取可重用句式、识别标准表达

智能模板提取：

• 结构模板：文档框架、章节模板、段落结构
• 内容模式：句式库、表达模式、术语集合
• 风格指南：语言规范、表达习惯、最佳实践

内容生成支持：

• 模板化：填空式创建、结构化组装、模块化复用
• 风格迁移：应用写作风格、模仿表达方式、保持一致性
• 质量保证：模式验证、结构检查、风格评估

使用场景

场景 1：学习优秀提示词 1. 分析样本 → 2. 识别结构（角色/任务/约束/格式）→ 3. 提炼模式 → 4. 创建模板 → 5. 生成新提示词

场景 2：模仿技术文档风格 1. 分析结构风格 → 2. 识别组织方式 → 3. 提炼术语规范 → 4. 创建风格指南 → 5. 指导生成

场景 3：文档质量提升 1. 对比分析 → 2. 识别差距 → 3. 应用优秀模式 → 4. 优化文档 → 5. 提供建议

参考资料

references/prompt_analysis_guide.md 提示词分析框架（结构分析模型、模式分类、质量标准、最佳实践）

references/tech_doc_patterns.md 技术文档写作模式（标准结构、表达模式、术语规范、格式指南）

references/style_analysis_framework.md 文档风格分析框架（风格维度模型、语言识别、风格迁移、一致性策略）

资产文件

assets/prompts/：角色设定、任务描述、约束条件、输出格式模板

assets/doc_templates/：技术文档、API文档、用户手册、其他类型模板

最佳实践

1. 多样本学习： 收集3-10个高质量样本，识别共性模式，提炼稳定有效模式 2. 模式验证： 在实际应用中验证，根据效果调整优化，持续改进模板库 3. 灵活应用： 不机械套用模板，根据需求灵活调整，保持创造性思维 4. 质量优先： 注重内容质量而非形式模仿，确保生成内容有价值

常见问题

Q: 学习多少个样本合适？ A: 建议 3-10 个高质量样本

Q: 如何处理不同风格？ A: 分别学习不同风格，创建多个风格模板

Q: 生成内容完全模仿原文？ A: 不，学习应用模式结构，内容本身应原创

Q: 支持非中文文档？ A: 支持多语言文档学习和模仿

---

由 semantic-compressor 在 2026-01-24 压缩