Create CLAUDE.md
This commit is contained in:
@@ -0,0 +1,194 @@
|
||||
# CLAUDE.md — Tinbird Database AI 助手指南
|
||||
|
||||
本文件指导 AI 助手在 `tinbird-database`（锡鸟科技公司知识库）中如何协助团队。
|
||||
|
||||
---
|
||||
|
||||
## 项目背景
|
||||
|
||||
**公司名称**：广州锡鸟科技有限公司
|
||||
**英文名**：Tinbird
|
||||
**所在地**：广州市天河区
|
||||
**主营业务**：独立游戏开发
|
||||
**在研项目**：《爱与机器人维修技术》（英文名：All Our Broken Parts）
|
||||
|
||||
### 团队构成（4名全职 + 3名顾问）
|
||||
|
||||
| 姓名 | 角色 | 备注 |
|
||||
|------|------|------|
|
||||
| 班春晖 | 制作人、创意总监、法人 | 持股34% |
|
||||
| 陈子钦 | 文案策划、音频 | 持股22% |
|
||||
| 周子迁 | 美术 | 持股22% |
|
||||
| 丁耘天 | 程序、财务负责人 | 持股22% |
|
||||
| 江卓亚 | 玩法设计顾问 | 兼职 |
|
||||
| 伍振彤 | 剧情顾问 | 兼职 |
|
||||
| 小唐 | 角色美术顾问 | 笔名，兼职 |
|
||||
|
||||
**融资状态**：奇绩创坛准备投资30万美元换取7%股份，需预留15%期权池。
|
||||
|
||||
---
|
||||
|
||||
## 知识库结构
|
||||
|
||||
本仓库采用**中文文件夹 + 英文文件名**的混合命名策略，兼顾可读性与工具兼容性。
|
||||
|
||||
```
|
||||
tinbird-database/
|
||||
├── CLAUDE.md # 本文件：AI 助手指南
|
||||
├── 公司知识库指南.md # 文档组织规范
|
||||
├── 现有文档.md # 待导入原始资料清单
|
||||
├── 公司概况/
|
||||
├── 组织与人员/
|
||||
├── 股权与融资/
|
||||
├── 法务与合规/
|
||||
├── 财务与行政/
|
||||
├── 知识产权与品牌/
|
||||
├── 发行与市场/
|
||||
├── 商务与合作/
|
||||
├── 时间线与里程碑/
|
||||
├── 对外话术与材料/
|
||||
└── 当前重点项目/
|
||||
```
|
||||
|
||||
### 核心文档
|
||||
|
||||
| 文档 | 作用 |
|
||||
|------|------|
|
||||
| [公司知识库指南.md](公司知识库指南.md) | 知识库组织规范、Brief 写作标准 |
|
||||
| [公司概况/公司概况.md](公司概况/公司概况.md) | 公司基本信息、团队、股权、项目概述 |
|
||||
| [现有文档.md](现有文档.md) | 未导入的原始资料清单及建议存放位置 |
|
||||
| 各分类 `brief.md` | 该类别的摘要与索引入口 |
|
||||
|
||||
---
|
||||
|
||||
## 工作原则
|
||||
|
||||
### 1. Brief 优先
|
||||
|
||||
每个分类目录下都有 `brief.md`，这是该类别的事实入口：
|
||||
|
||||
- **先读 brief**：获取摘要、关键数字和索引
|
||||
- **再按需深入**：通过 brief 中的索引找到原件
|
||||
- **更新 brief**：添加新文档时同步更新 brief 的索引表
|
||||
|
||||
### 2. 单一事实源
|
||||
|
||||
- 关键日期、正式名称、对外数字只在**一处**写定
|
||||
- 其他文档通过引用或链接指向该源头
|
||||
- 发现不一致时，以最新日期的文档为准并提醒团队
|
||||
|
||||
### 3. 敏感信息处理
|
||||
|
||||
- **股权细节**：可仅存索引或注明「向丁耘天索取」
|
||||
- **合同全文**：brief 中只写摘要和存放位置
|
||||
- **账户信息**：控制访问范围，brief 中不写具体数字
|
||||
- **身份证号等**：不在 markdown 中存放，注明原件位置
|
||||
|
||||
### 4. 中文回复
|
||||
|
||||
**必须用中文回复**，这是团队设定的规则。
|
||||
|
||||
---
|
||||
|
||||
## 常见任务指南
|
||||
|
||||
### 导入 Word/PDF 文档
|
||||
|
||||
使用仓库内置的 `.cursor/skills/docx-pdf-to-markdown/` 工具：
|
||||
|
||||
1. **`.docx` 文件**：使用 Pandoc 转换为 Markdown
|
||||
2. **文本型 `.pdf`**：使用 Poppler `pdftotext` 提取（不用 Pandoc，因其读 PDF 不稳定）
|
||||
3. 转换后放入对应分类文件夹
|
||||
4. **更新该分类的 `brief.md`**：添加索引条目
|
||||
|
||||
### 导出为 Word 文档
|
||||
|
||||
使用 `.cursor/skills/markdown-to-docx/` 工具：
|
||||
|
||||
```powershell
|
||||
# 在 PowerShell 中执行
|
||||
.cursor/skills/markdown-to-docx/scripts/convert-to-docx.ps1 -InputFile "文档路径.md"
|
||||
```
|
||||
|
||||
### 更新 Brief
|
||||
|
||||
当添加或修改文档时，按以下顺序更新 brief：
|
||||
|
||||
1. 更新「一句话摘要」（如有状态变化）
|
||||
2. 更新「要点列表」（如有新增要点）
|
||||
3. 更新「索引表」（添加新文档条目）
|
||||
4. 更新「关键事实」（如有日期/数字变更）
|
||||
5. 更新文末 `last_updated` 时间戳
|
||||
|
||||
---
|
||||
|
||||
## 重要术语与名称
|
||||
|
||||
### 公司相关
|
||||
|
||||
| 中文 | 英文 | 备注 |
|
||||
|------|------|------|
|
||||
| 广州锡鸟科技有限公司 | Tinbird / Tinbird Games | 正式公司名 |
|
||||
| 爱与机器人维修技术 | All Our Broken Parts | 在研游戏 |
|
||||
| 奇绩创坛 | MiraclePlus | 投资方 |
|
||||
| 机核 | Gcores | 大中华地区PC发行商 |
|
||||
| TapTap | - | 移动端发行平台 |
|
||||
|
||||
### 项目相关
|
||||
|
||||
| 术语 | 解释 |
|
||||
|------|------|
|
||||
| 大遗忘 | 游戏世界观核心设定 |
|
||||
| 机体 | 被改造后的人类 |
|
||||
| 主脑 | 统治世界的AI |
|
||||
| 原型 | 机体视为缺陷的人类情感 |
|
||||
|
||||
---
|
||||
|
||||
## 文件模板
|
||||
|
||||
### 新建 Brief 模板
|
||||
|
||||
```markdown
|
||||
# [分类名] Brief
|
||||
|
||||
## 一句话摘要
|
||||
|
||||
[本类当前状态，如：股权截至2025年X月X日，奇绩创坛投资进行中]
|
||||
|
||||
## 要点列表
|
||||
|
||||
1. [要点1]
|
||||
2. [要点2]
|
||||
3. [要点3]
|
||||
|
||||
## 索引表
|
||||
|
||||
| 文件名 | 类型 | 路径 | 备注 |
|
||||
|--------|------|------|------|
|
||||
| [文档名] | pdf/md/docx | [路径] | [是否敏感/需更新] |
|
||||
|
||||
## 关键事实
|
||||
|
||||
- 日期：[关键日期]
|
||||
- 主体：[相关方名称]
|
||||
- 编号：[如有编号]
|
||||
|
||||
---
|
||||
|
||||
*last_updated: YYYY-MM-DD*
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. **不要重复项目知识库内容**：游戏设计、叙事设定、版本管理在另一仓库
|
||||
2. **保持 brief 简洁**：每份 brief 控制在 100 行以内，方便快速浏览
|
||||
3. **交叉引用时使用相对路径**：如 `[股权与融资/brief.md](股权与融资/brief.md)`
|
||||
4. **日期格式统一**：使用 `YYYY-MM-DD` 格式
|
||||
5. **定期同步**：建议重大变更后 24 小时内更新 brief
|
||||
|
||||
---
|
||||
|
||||
*本文档由 AI 助手根据 [公司知识库指南.md](公司知识库指南.md) 和 [公司概况/公司概况.md](公司概况/公司概况.md) 生成。*
|
||||
Reference in New Issue
Block a user