Markdown 文档撰写提示词大全

本文档汇总撰写高质量 Markdown 文档时常用的提示词模板与最佳实践，覆盖结构、内容、可视化、代码、排版、自查等全流程。

---

目录

• 一、文档结构类提示词
• 二、内容质量类提示词
• 三、可视化图表类提示词
• 四、代码示例类提示词
• 五、排版格式类提示词
• 六、自查校对类提示词
• 七、特定场景类提示词
• 八、综合万能模板

---

一、文档结构类提示词

1.1 章节规划提示词

请按以下结构组织文档：
1. 引言（背景与动机）
2. 核心概念（关键术语定义）
3. 详细说明（含 3-5 个子主题）
4. 示例（不少于 N 个）
5. 最佳实践
6. 总结
每个一级章节下必须有 3 个以上的二级章节。

1.2 逻辑层次提示词

请使用"总-分-总"结构：
- 每个一级章节先用一段话概述本章核心
- 中间用 2-4 个二级章节展开
- 最后用要点列表总结关键收获

1.3 章节深度提示词

请控制章节深度：
- 一级章节不超过 7 个
- 二级章节不超过 6 个
- 三级章节不超过 5 个
- 单个章节内容不超过 800 字

1.4 文档骨架提示词

请先输出文档大纲（仅章节标题）供我确认，
确认后再撰写具体内容。

---

二、内容质量类提示词

2.1 准确性提示词

请确保：
- 所有数字、单位、日期前后一致
- 技术术语使用准确，不要望文生义
- 音译词按音译解释，不强行释义
- 相似概念严格区分（如 Flyweight vs Object Pool）

2.2 完整性提示词

请覆盖以下方面：
- 是什么（定义）
- 为什么（动机与适用场景）
- 怎么做（实现步骤）
- 优缺点
- 与其他方案的对比
- 实战示例

2.3 专业性提示词

请使用专业但易懂的语言：
- 首次出现的英文术语用括号标注原文
- 关键概念用加粗强调
- 提供中英文对照表
- 引用权威来源（书籍、官方文档、RFC）

2.4 受众适配提示词

目标读者：[初级开发者 / 资深工程师 / 架构师 / 产品经理 / 学生]
请根据读者背景调整：
- 术语深度
- 概念解释的详细程度
- 示例的抽象级别
- 假设的前置知识

---

三、可视化图表类提示词

3.1 Mermaid 偏好提示词

请使用 Mermaid 图表替代纯 ASCII 示意图，包括但不限于：
- 流程图（flowchart）用于展示逻辑分支
- 时序图（sequenceDiagram）用于展示调用过程
- 类图（classDiagram）用于展示结构关系
- 思维导图（mindmap）用于发散性内容
- 饼图（pie）用于占比分布
- 状态图（stateDiagram）用于状态流转

3.2 Mermaid 语法避坑提示词

编写 Mermaid 时请遵守：
- 节点标签里禁用双引号嵌套、星号、括号等特殊字符
- 中文标签统一用全角标点
- 慎用 xychart-beta（兼容性差）
- 慎用 subgraph 内 direction TB 与外层 LR 冲突
- 优先使用 classDef 统一样式而非逐个 style

3.3 图表适配提示词

请根据内容选择图表类型：
- 决策类内容 → 流程图
- 角色交互类 → 时序图或类图
- 数据对比类 → 表格或柱状图
- 占比分布类 → 饼图（仅当各部分差距不大时）
- 发散归纳类 → 思维导图

3.4 避免无效图表提示词

使用图表时请注意：
- 饼图避免单一占比超过 80%（否则失去对比价值）
- 流程图避免分支超过 7 个
- 时序图避免超过 5 个参与者
- 思维导图避免层级超过 4 层

---

四、代码示例类提示词

4.1 示例要求提示词

请提供完整可运行的代码示例：
- 包含所有 import 语句
- 不使用未定义的依赖
- 关键逻辑添加注释
- 配套提供输入与预期输出

4.2 示例数量提示词

请提供 3-4 个由浅入深的示例：
- 示例一：基础用法（10-30 行）
- 示例三：进阶用法（30-80 行）
- 示例四：复杂场景或性能优化（80+ 行）
- 最后一个示例包含完整业务逻辑

4.3 代码风格提示词

请遵循以下代码风格：
- 命名：类名 PascalCase，方法/变量 camelCase
- 注释：关键逻辑必须有行内注释
- 格式：每个方法不超过 30 行
- 错误处理：必须处理异常情况
- 不要使用 println 调试，用日志框架

4.4 代码精简提示词

请精简代码：
- 删除所有未使用的 import
- 删除冗余的注释
- 删除注释掉的代码
- 删除调试用的 print 语句

---

五、排版格式类提示词

5.1 标题层级提示词

请严格使用 Markdown 标题层级：
- 一级标题（#）仅文档标题使用 1 次
- 二级标题（##）用于主要章节
- 三级标题（###）用于子章节
- 四级标题（####）用于更细的内容
- 不跳级使用（如 ### 后直接用 #####）

5.2 强调使用提示词

请合理使用强调语法：
- 加粗（**xxx**）用于关键术语、概念名词
- 斜体（*xxx*）用于补充说明、外文术语
- 行内代码（`xxx`）用于代码、命令、文件路径
- 删除线（~~xxx~~）用于已废弃或错误的表述

5.3 列表使用提示词

请按内容选择列表类型：
- 无序列表：并列项、特性、步骤
- 有序列表：有明确顺序的步骤、优先级
- 任务列表：可勾选的待办项
- 嵌套不超过 3 层

5.4 表格规范提示词

请按规范编写表格：
- 表头必须有明确含义
- 列对齐：第一列左对齐，第二列起左对齐
- 数字列右对齐
- 单元格内容简洁，不超过 30 字
- 表头与数据行用 ---- 分隔
- 长表格拆分为多个短表格

5.5 引用块提示词

请使用引用块（>）突出：
- 重要提示
- 注意事项
- 名言或权威引用
- 与上下文的对话或补充

---

六、自查校对类提示词

6.1 通用自查提示词

撰写完成后请自查：
1. 术语释义是否准确
2. 数据前后是否一致
3. 示例是否典型且可运行
4. 图表与描述是否对应
5. 是否存在错别字或语法错误
6. 章节顺序是否逻辑清晰
7. 重要概念是否有解释

6.2 数值一致性提示词

请检查所有数值的一致性：
- 计算公式与结果匹配
- 表格中的数字与正文呼应
- 示例代码中的数值与说明一致
- 单位、量级前后统一

6.3 概念准确性提示词

请严格检查：
- 模式名称是否对应其典型案例
- 不相似的概念未被强行类比
- 译名解释合理（音译还是意译）
- 引用来源真实可查

6.4 交叉引用提示词

请确保交叉引用的准确性：
- 章节编号与正文一致
- 代码示例编号与正文中提到的对应
- 图表引用与实际图表顺序一致
- 外部链接指向正确

---

七、特定场景类提示词

7.1 技术文档类

请撰写一份技术文档，要求：
- 准确描述技术原理
- 提供安装与配置步骤
- 包含完整的 API 参考
- 给出典型用例
- 列出常见问题与解决方案
- 配套版本说明与依赖列表

7.2 设计模式类

请撰写设计模式文档，要求：
- 说明意图与适用场景
- 给出 UML 类图
- 给出协作时序图
- 提供由浅入深的代码示例
- 对比相似模式
- 列举 JDK 中的实际应用

7.3 教程入门类

请撰写入门教程，要求：
- 从零开始，假设读者无任何前置知识
- 每一步都给出操作指令与预期结果
- 关键概念用生活化类比解释
- 提供常见错误与排查方法
- 最后给出综合练习

7.4 知识科普类

请撰写知识科普文章，要求：
- 用生动有趣的语言引入主题
- 用类比与故事帮助理解
- 配合图示降低理解门槛
- 避免过度专业的术语
- 结尾引向深入学习的方向

7.5 决策分析类

请撰写决策分析文档，要求：
- 列出所有可行方案
- 每个方案给出优缺点
- 用表格对比关键指标
- 给出推荐方案及理由
- 说明决策的适用边界

7.6 项目总结类

请撰写项目总结文档，要求：
- 项目背景与目标
- 已完成的核心功能
- 关键技术与架构决策
- 遇到的问题与解决方案
- 后续优化方向
- 经验与教训

---

八、综合万能模板

8.1 标准技术文档模板

请撰写一份《[主题]》技术文档，要求：

【结构】
1. 引言（200 字）：背景与目标
2. 核心概念：定义与关键术语
3. 详细说明：分 3-5 个子主题展开
4. 代码示例：3-4 个由浅入深
5. 最佳实践：5-8 条要点
6. 常见问题：3-5 个 FAQ
7. 总结：3-5 句话概括

【要求】
- 使用 Mermaid 图表（流程图、时序图、类图等）
- 关键术语加粗强调
- 数据前后一致
- 完成后自查术语准确性、数据一致性、示例典型性

【受众】
[初级 / 中级 / 高级]开发者

8.2 简洁说明文档模板

请撰写一份《[主题]》说明文档：

【结构】
1. 一句话定义
2. 三种典型场景
3. 三个核心概念
4. 一段示例代码
5. 三条使用建议

【要求】
- 总字数控制在 800 字以内
- 配 1-2 张图
- 不使用复杂表格

8.3 深度专题文档模板

请撰写一份《[主题]》深度专题：

【结构】
1. 前言：领域现状与挑战
2. 理论基础：核心原理
3. 实现细节：关键代码与算法
4. 性能分析：基准测试与优化
5. 案例研究：3 个真实场景
6. 工具与生态：相关工具链
7. 未来展望：发展趋势

【要求】
- 字数 5000 字以上
- 至少 6 张图表
- 至少 4 个代码示例
- 引用至少 5 篇权威文献

---

附录：常见错误清单

类别	错误示例	正确做法
术语	强行给音译词字面释义	按音译解释
模式	混淆相似模式	严格区分核心意图
数据	数字前后矛盾	全文回查数值
图表	饼图单一占比过大	改用柱状图
图表	Mermaid 语法错误	用 classDef 统一样式
代码	未使用的 import	写完删除冗余
示例	描述与图不符	写完后通读核对
结构	章节序号跳级	严格按 1, 1.1, 1.1.1

---

附录：自查清单（Checklist）

□ 所有数据前后一致
□ 所有术语解释准确
□ 所有示例可运行且典型
□ 所有图表语法正确
□ 所有图表与描述对应
□ 所有章节编号连贯
□ 没有跳级标题
□ 没有未使用的代码 import
□ 没有错别字与语法错误
□ 引用的外部资料真实可查

---

使用建议：将本提示词大全作为参考，根据具体场景灵活组合。不要试图一次性使用所有提示词——那会让生成的内容变得僵硬。优先选择与你当前任务最相关的 3-5 条提示词组合使用。