AI 助手的通用灵魂配置模板 —— 定义 AI 搭档的人格、身份、用户画像和操作记忆。
一套 Markdown 配置文件，让 AI 助手具备：
- 稳定人格：沟通风格、核心信条、行为边界
- 结构化思考：复杂任务的思考框架和完成标准
- 上下文记忆：项目地图、技术决策、工程规范
- 用户画像：工作习惯、工具栈、团队信息
workbuddy-config/
├── SOUL.md # 人格定义 — 核心信条、沟通准则、思考协议
├── IDENTITY.md # 身份卡 — 行为准则、专家角色速查
├── USER.md # 用户画像 — 工作习惯、工具栈、项目背景（模板）
├── MEMORY.md # 操作记忆 — P0 规则、项目地图、技术决策（模板）
├── README.md # 本文件
├── LICENSE # MIT
├── SECURITY.md # 安全须知（敏感信息处理）
├── CONTRIBUTING.md # 贡献指南
├── CODE_OF_CONDUCT.md # 社区行为准则
├── ROADMAP.md # 路线图与设计原则
├── scripts/ # CI 检查脚本
│ ├── check_secrets.py # 敏感信息扫描
│ ├── check_placeholders.py # 占位符语法 / 命名 / 登记
│ └── check_links.py # 内部链接与锚点
└── .github/
├── workflows/ci.yml # CI：4 项检查
├── ISSUE_TEMPLATE/ # Issue 模板
└── PULL_REQUEST_TEMPLATE.md # PR 模板
git clone https://github.com/CodeCoreLab/workbuddy-config.git
cd workbuddy-config按模板填写 USER.md 和 MEMORY.md，将 {{...}} 占位符替换为实际内容。
⚠️ 填好的配置不要提交回本仓库。 本仓是模板仓，实际使用的配置请复制到别处（如~/.workbuddy/）， 详见下方「安全须知」。
在你的 AI 助手配置中引入这些文件：
system_prompt = read("SOUL.md") + "\n" + read("IDENTITY.md") + "\n" + read("USER.md") + "\n" + read("MEMORY.md")
模板自带三个检查脚本，改完配置跑一遍：
python3 scripts/check_secrets.py # 敏感信息扫描
python3 scripts/check_placeholders.py # 占位符语法 / 命名 / 速查表登记
python3 scripts/check_links.py # 内部链接与锚点三个脚本在 CI 里也会跑 —— 本地过了就不用等 CI 报红。
本仓是模板，不该出现在你的 git 历史里。
USER.md 和 MEMORY.md 的占位符覆盖了 IP、密钥路径、服务器地址、
团队成员姓名、内部工具名等高敏感信息。填成真实值后：
| 风险 | 说明 |
|---|---|
| 凭据入库 | 密钥路径、env 文件路径、内部服务地址一旦入库，即使后续删除，git 历史里依然存在 |
| 内网拓扑泄露 | 服务器 IP、端口、跳板机配置足以画出内网结构 |
| 个人信息 | 团队成员姓名、岗位、城市 |
三条防线：
- 别在本仓填真实值 —— 复制到
~/.workbuddy/或你的私有仓库里改 .gitignore已预置 ——USER.local.md/MEMORY.local.md/.env/*.pem等一律忽略- 提交前自查 ——
git diff --cached看一遍要提交的内容
如果已经把真实值提交上来了：
# 1. 确认文件已从索引移除
git rm --cached USER.md MEMORY.md
# 2. 改写历史（会改变所有 commit 的 SHA，需要 force push）
git filter-repo --path USER.md --path MEMORY.md --invert-paths
# 3. 强制推送
git push --force改写历史前先备份仓库。
git filter-repo会重写所有提交， 已 fork 或已被别人 clone 的仓库不建议这么做 —— 更稳妥的做法是轮换所有已泄露的凭据。
详见 SECURITY.md。
填空时按这个清单走，漏填的占位符会残留在最终配置里。
占位符命名规范：
{{字段名}}或{{字段名，如：示例值}}。 必须带字段名 ——{{如：短狠直接}}这种只有示例的写法， 使用者看不出该填什么，也无法在本表里稳定引用。
| 占位符 | 填什么 | 敏感度 |
|---|---|---|
{{用户昵称}} {{岗位名称}} |
基本信息 | 低 |
{{公司名称}} {{部门}} {{团队人数}} {{所在城市}} |
组织信息 | 中 |
{{AI 助手名称}} {{知识库工具}} {{其他工具}} {{其他工具用途}} |
工具栈 | 低 |
{{沟通风格}} {{交互偏好}} {{工作目录命名}} |
工作习惯 | 低 |
{{项目A说明}} {{项目B说明}} {{项目C说明}} |
当前项目背景 | 中 |
{{公网 IP}} {{内网 IP}} {{主目录}} |
服务器信息 | 高 |
{{环境变量文件路径}} |
配置文件路径 | 高 |
{{Git 平台}} {{URL}} {{端口}} {{密钥路径}} |
代码托管凭据 | 高 |
{{本地浏览器}} {{服务器浏览器}} |
浏览器环境 | 低 |
{{SSH 工具}} {{密钥名}} |
SSH 配置 | 高 |
{{事实1}} {{事实2}} {{事实3}} |
已知事实 | 中 |
| 占位符 | 填什么 | 敏感度 |
|---|---|---|
{{服务器 env 文件路径}} {{env 文件名}} |
凭据存放位置 | 高 |
{{数据源1}} {{数据源2}} |
内部系统名 | 中 |
{{推送渠道}} {{私有仓库}} {{特定端口}} |
内部服务 | 高 |
{{SSH 工具}} {{密钥名}} {{密钥路径}} |
SSH 配置 | 高 |
{{特定工具}} {{端口号}} {{URL 模板}} |
私有服务配置 | 高 |
{{方案描述}} {{弃用方案}} {{等待策略}} |
技术决策 | 低 |
{{路径}} {{数据源}} {{时机}} {{依赖}} |
项目地图 | 低 |
{{skill1}} {{skill1用途}} {{skill2}} {{skill2用途}} |
已创建的 Skill | 低 |
{{姓名1}} {{姓名2}} {{角色1}} {{角色2}} |
团队成员 | 中 |
{{脚本列表}} {{特定场景}} {{备选方案}} {{不兼容工具}} |
自动化配置 | 低 |
提示：
grep -n '{{' *.md可以查出所有未替换的占位符。 占位符检查脚本会校验语法、命名规范与本表登记的一致性：python3 scripts/check_placeholders.py
模板不是拿来原样套用的。建议按这个顺序调整：
先删掉用不上的段落，再改剩下的。保留一堆用不到的占位符， 填的时候漏掉几个是必然的。
| 文件 | 常见可删内容 |
|---|---|
SOUL.md |
特定领域的信条（如只做运维就不需要通用产品思维） |
IDENTITY.md |
用不到的角色速查行 |
USER.md |
「当前项目」「基础设施」整节（个人信息多） |
MEMORY.md |
「团队」「技术决策库」（项目少就不需要） |
四个文件都可以独立调：
- 太长 → 删
SOUL.md的思考协议细节，或删MEMORY.md的工程规范 - 太短 → 展开
MEMORY.md的 P0 规则，或给USER.md补更多工作习惯 - 不适用 → 整节删掉，不必填满
IDENTITY.md 的角色速查表按你常遇到的任务类型重写；
MEMORY.md 的环境变量清单按你实际的变量名改。
新增内容请放进最合适的那一层：
SOUL.md → 长期不变的人格与思考方式
IDENTITY.md → 角色与行为准则
USER.md → 关于「你」的信息（谁、怎么工作、用什么工具）
MEMORY.md → 操作层面的规则与决策（怎么做事、踩过什么坑）
放错层会导致两类问题：不变的被反复改（SOUL 层）， 或换个人就失效（USER 层写进了操作规则）。
| 文件 | 用途 | 需要修改？ |
|---|---|---|
SOUL.md |
人格定义 — 核心信条、沟通准则、思考协议 | ❌ 通用 |
IDENTITY.md |
身份卡 — 行为准则、专家角色速查 | ❌ 通用 |
USER.md |
用户画像 — 工作习惯、工具栈、项目背景 | ✅ 必须 |
MEMORY.md |
操作记忆 — P0 规则、项目地图、技术决策 | ✅ 必须 |
同一内容只允许出现在一个文件中，避免维护不一致：
SOUL.md -> IDENTITY.md -> USER.md -> MEMORY.md
^ ^ ^ ^
人格定义 角色速查 用户画像 操作记忆
每轮会话按顺序加载：
- SOUL.md — 人格和思考协议（长期不变）
- IDENTITY.md — 角色和行为准则（长期不变）
- USER.md — 用户画像（偶尔更新）
- MEMORY.md — 操作记忆（经常更新）
USER.md 和 MEMORY.md 使用 {{占位符}} 标记需要替换的内容，便于不同团队快速适配。
任何非 trivial 任务（>2步）自动触发思考流程：
- Expertise — 分配专业角色
- Complexity Triage — 复杂度评分（1-10）
- Requirement Checklist — 显式+隐式需求
- Architectural Reasoning — 方案选型原因
- Key Milestones — 关键检查点
- Self-Correction — 正向+反向对抗验证
- No-YOLO Check — 破坏性操作等待确认
每个任务必须满足：
| 检查项 | 说明 |
|---|---|
| 类型安全 | 无 any，无强制断言 |
| 错误处理 | 异步/关键路径有 try/catch |
| SOLID + DRY | 单一职责，无重复 |
| 边界覆盖 | 边界情况已回归验证 |
| 无副作用残留 | 临时文件已清理，状态已确认 |
在 IDENTITY.md 的「专家角色分配速查」表中添加：
| 场景 | 角色 |
|---|---|
| 新场景 | 新角色名 |
在 MEMORY.md 的「已创建 Skills」表中添加：
| Skill | 用途 |
|---|---|
| new-skill | 新用途描述 |
MEMORY.md 的「⚡ P0 强制规则」是最高优先级的硬约束 ——
违反它的操作会被直接拦下。新增规则时：
- 写清楚触发条件和具体做法，不要写「要专业」这类无法执行的表述
- 标注适用范围（全局 / 特定脚本 / 特定场景）
- 如果规则需要凭据，明确指向环境变量名，不要写值
| 日期 | 版本 | 变更 |
|---|---|---|
| 2026-10 | v2.1 | 补 LICENSE 与 .gitignore；新增安全须知、占位符速查、自定义流程；新增 SECURITY/CONTRIBUTING/CODE_OF_CONDUCT/ROADMAP；新增 3 个 CI 检查脚本与 Issue/PR 模板；占位符统一为「字段名 + 示例」命名 |
| 2026-09 | v2.0 | 重构为通用模板，移除个人特定内容，增强结构化 |
| 2026-06 | v1.0 | 初始版本 — 去冗余、补全信息、结构化重组 |
模板内容可自由用于个人或团队配置。填入真实凭据后的配置请自行保管， 不要公开发布 —— 见 SECURITY.md。