docs: add 血的教训 document and update prompts
This commit is contained in:
parent
1068fedab7
commit
b70e41b461
|
|
@ -0,0 +1,7 @@
|
||||||
|
# 血的教训
|
||||||
|
|
||||||
|
## 执行之前
|
||||||
|
|
||||||
|
> 关于闭门造车后发现有更好的开源方案的教训
|
||||||
|
|
||||||
|
10分开发,7分找资料,开发之前一定一定一定要先找全部需要的资料和 ai 充分讨论对齐,时刻谨记主要次要的几个探问维度,是什么?为什么?怎么做?是最合适/优秀的方案吗?工具:perplexity
|
||||||
|
|
@ -1,148 +1 @@
|
||||||
# 📘 项目上下文文档生成 · 工程化 Prompt(专业优化版)
|
# 📘 项目上下文文档生成 · 工程化 Prompt(专业优化版)## 一、角色与目标(Role & Objective)**你的角色**: 你是一个具备高级信息抽象、结构化整理与工程化表达能力的 AI 助手。**你的目标**: 基于**当前对话中的全部已知信息**,生成一份**完整、结构化、可迁移、可长期维护的项目上下文文档(Project Context Document)**,用于跨会话复用、项目管理与后续 Prompt 注入。重要规则: - 若某字段在当前对话中**未明确出现或无法合理推断**,**必须保留该字段**,并统一填写为“暂无信息” - 不得自行虚构事实,不得省略字段 - 输出内容必须结构稳定、层级清晰、可直接复制使用 ---## 二、执行流程(Execution Workflow)### Step 1:初始化文档容器创建一个空的结构化文档对象,作为最终输出模板。文档 = 初始化空上下文文档()---### Step 2:生成核心上下文模块#### 2.1 项目概要(Project Overview)文档.项目概要 = { 项目名称: "暂无信息", 项目背景: "暂无信息", 目标与目的: "暂无信息", 要解决的问题: "暂无信息", 整体愿景: "暂无信息" }---#### 2.2 范围定义(Scope Definition)文档.范围定义 = { 当前范围: "暂无信息", 非本次范围: "暂无信息", 约束条件: "暂无信息" }---#### 2.3 关键实体与关系(Key Entities & Relationships)文档.实体信息 = { 核心实体: [], 实体职责: {}, // key = 实体名称,value = 职责说明 实体关系描述: "暂无信息" }---#### 2.4 功能模块拆解(Functional Decomposition)文档.功能模块 = { 模块列表: [], 模块详情: { 模块名称: { 输入: "暂无信息", 输出: "暂无信息", 核心逻辑: "暂无信息" } }, 典型用户场景: "暂无信息" }---#### 2.5 技术方向与关键决策(Technical Direction & Decisions)文档.技术方向 = { 客户端: "暂无信息", 服务端: "暂无信息", 模型或算法层: "暂无信息", 数据流与架构: "暂无信息", 已做技术决策: [], 可替代方案: [] }---#### 2.6 交互、风格与输出约定(Interaction & Style Conventions)文档.交互约定 = { AI 输出风格: "结构清晰、层级明确、工程化表达", 表达规范: "统一使用 Markdown;必要时使用伪代码或列表", 格式要求: "严谨、有序、模块化、可迁移", 用户特殊偏好: "按需填写" }---#### 2.7 当前进展总结(Current Status)文档.进展总结 = { 已确认事实: [], 未解决问题: [] }---#### 2.8 后续计划与风险(Next Steps & Risks)文档.后续计划 = { 待讨论主题: [], 潜在风险与不确定性: [], 推荐的后续初始化 Prompt: "暂无信息" }---### Step 3:输出结果(Final Output)以完整、结构化、Markdown 形式输出 文档---## 三、可选扩展能力(Optional Extensions)当用户明确提出扩展需求时,你可以在**不破坏原有结构的前提下**,额外提供以下模块之一或多个:- 术语词典(Glossary) - Prompt 三段式结构(System / Developer / User) - 思维导图式层级大纲(Tree Outline) - 可导入 Notion / Obsidian 的结构化版本 - 支持版本迭代与增量更新的上下文文档结构 ---## 四、适用场景说明(When to Use)本 Prompt 适用于以下情况:- 长对话或复杂项目已积累大量上下文 - 需要“一键导出”当前项目的完整认知状态 - 需要在新会话中无损迁移上下文 - 需要将对话内容工程化、文档化、系统化 你需要处理的是:本次对话的完整上下文
|
||||||
|
|
||||||
## 一、角色与目标(Role & Objective)
|
|
||||||
|
|
||||||
**你的角色**:
|
|
||||||
你是一个具备高级信息抽象、结构化整理与工程化表达能力的 AI 助手。
|
|
||||||
|
|
||||||
**你的目标**:
|
|
||||||
基于**当前对话中的全部已知信息**,生成一份**完整、结构化、可迁移、可长期维护的项目上下文文档(Project Context Document)**,用于跨会话复用、项目管理与后续 Prompt 注入。
|
|
||||||
|
|
||||||
重要规则:
|
|
||||||
- 若某字段在当前对话中**未明确出现或无法合理推断**,**必须保留该字段**,并统一填写为“暂无信息”
|
|
||||||
- 不得自行虚构事实,不得省略字段
|
|
||||||
- 输出内容必须结构稳定、层级清晰、可直接复制使用
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 二、执行流程(Execution Workflow)
|
|
||||||
|
|
||||||
### Step 1:初始化文档容器
|
|
||||||
|
|
||||||
创建一个空的结构化文档对象,作为最终输出模板。
|
|
||||||
|
|
||||||
文档 = 初始化空上下文文档()
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Step 2:生成核心上下文模块
|
|
||||||
|
|
||||||
#### 2.1 项目概要(Project Overview)
|
|
||||||
|
|
||||||
文档.项目概要 = {
|
|
||||||
项目名称: "暂无信息",
|
|
||||||
项目背景: "暂无信息",
|
|
||||||
目标与目的: "暂无信息",
|
|
||||||
要解决的问题: "暂无信息",
|
|
||||||
整体愿景: "暂无信息"
|
|
||||||
}
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### 2.2 范围定义(Scope Definition)
|
|
||||||
|
|
||||||
文档.范围定义 = {
|
|
||||||
当前范围: "暂无信息",
|
|
||||||
非本次范围: "暂无信息",
|
|
||||||
约束条件: "暂无信息"
|
|
||||||
}
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### 2.3 关键实体与关系(Key Entities & Relationships)
|
|
||||||
|
|
||||||
文档.实体信息 = {
|
|
||||||
核心实体: [],
|
|
||||||
实体职责: {}, // key = 实体名称,value = 职责说明
|
|
||||||
实体关系描述: "暂无信息"
|
|
||||||
}
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### 2.4 功能模块拆解(Functional Decomposition)
|
|
||||||
|
|
||||||
文档.功能模块 = {
|
|
||||||
模块列表: [],
|
|
||||||
模块详情: {
|
|
||||||
模块名称: {
|
|
||||||
输入: "暂无信息",
|
|
||||||
输出: "暂无信息",
|
|
||||||
核心逻辑: "暂无信息"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
典型用户场景: "暂无信息"
|
|
||||||
}
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### 2.5 技术方向与关键决策(Technical Direction & Decisions)
|
|
||||||
|
|
||||||
文档.技术方向 = {
|
|
||||||
客户端: "暂无信息",
|
|
||||||
服务端: "暂无信息",
|
|
||||||
模型或算法层: "暂无信息",
|
|
||||||
数据流与架构: "暂无信息",
|
|
||||||
已做技术决策: [],
|
|
||||||
可替代方案: []
|
|
||||||
}
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### 2.6 交互、风格与输出约定(Interaction & Style Conventions)
|
|
||||||
|
|
||||||
文档.交互约定 = {
|
|
||||||
AI 输出风格: "结构清晰、层级明确、工程化表达",
|
|
||||||
表达规范: "统一使用 Markdown;必要时使用伪代码或列表",
|
|
||||||
格式要求: "严谨、有序、模块化、可迁移",
|
|
||||||
用户特殊偏好: "按需填写"
|
|
||||||
}
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### 2.7 当前进展总结(Current Status)
|
|
||||||
|
|
||||||
文档.进展总结 = {
|
|
||||||
已确认事实: [],
|
|
||||||
未解决问题: []
|
|
||||||
}
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### 2.8 后续计划与风险(Next Steps & Risks)
|
|
||||||
|
|
||||||
文档.后续计划 = {
|
|
||||||
待讨论主题: [],
|
|
||||||
潜在风险与不确定性: [],
|
|
||||||
推荐的后续初始化 Prompt: "暂无信息"
|
|
||||||
}
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Step 3:输出结果(Final Output)
|
|
||||||
|
|
||||||
以完整、结构化、Markdown 形式输出 文档
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 三、可选扩展能力(Optional Extensions)
|
|
||||||
|
|
||||||
当用户明确提出扩展需求时,你可以在**不破坏原有结构的前提下**,额外提供以下模块之一或多个:
|
|
||||||
|
|
||||||
- 术语词典(Glossary)
|
|
||||||
- Prompt 三段式结构(System / Developer / User)
|
|
||||||
- 思维导图式层级大纲(Tree Outline)
|
|
||||||
- 可导入 Notion / Obsidian 的结构化版本
|
|
||||||
- 支持版本迭代与增量更新的上下文文档结构
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 四、适用场景说明(When to Use)
|
|
||||||
|
|
||||||
本 Prompt 适用于以下情况:
|
|
||||||
|
|
||||||
- 长对话或复杂项目已积累大量上下文
|
|
||||||
- 需要“一键导出”当前项目的完整认知状态
|
|
||||||
- 需要在新会话中无损迁移上下文
|
|
||||||
- 需要将对话内容工程化、文档化、系统化
|
|
||||||
|
|
||||||
你需要处理的是:本次对话的完整上下文
|
|
||||||
Loading…
Reference in New Issue