SanQian.Xu 项目知识库

统一管理 D:\SanQian.Xu 下多个项目的项目框架、功能模块、git 提交的功能变更。

目录速览

project-knowledge-base/
├── INDEX.md                # 项目速查表（按角色/技术栈/标签）
├── projects.json           # 项目元信息（脚本读取）
├── iterations.json         # 里程碑定义
├── projects/
│   ├── claude-code-ui/                # Claude Code UI（克隆参考项目）
│   ├── claude-devsprite/              # Claude-DevSprite（CLI + Web Dashboard）
│   ├── token-consumption-leaderboard/ # Token 消耗排行榜
│   ├── quant-platform/                # 量化金融数据平台
│   ├── web-remote-control/            # WebRTC 远程桌面
│   └── tokenrank-cloud/               # TokenRank Cloud
├── scripts/
│   ├── gen-commit-doc.ps1  # 核心：git log → 功能文档
│   ├── gen-commit-doc.sh   # Bash 版
│   ├── list-features.ps1   # 列出某项目所有功能
│   └── register-scheduled-task.bat  # 注册每日定时任务
└── templates/              # 文档模板

阅读路径

1. 第一次来 → 看 INDEX.md 了解项目概况
2. 找某个项目的框架 → projects/<slug>/framework.md
3. 找某个功能模块 → projects/<slug>/modules/00-index.md
4. 找某次 git 提交的功能变更 → projects/<slug>/commits/00-index.md
5. 找项目与源码的对应关系 → projects/<slug>/references/source-map.md

项目 slug 对照

| slug | 项目目录 | 显示名 | |------|----------|--------| | claude-code-ui | Claude-Code-UI\Reference Project\claudecodeui | Claude Code UI | | claude-devsprite | Claude-DevSprite | Claude-DevSprite | | token-consumption-leaderboard | Token Consumption Leaderboard | Token Consumption Leaderboard | | quant-platform | quant-platform | quant-platform | | web-remote-control | web-remote-control | web-remote-control | | tokenrank-cloud | TokenRank Cloud | TokenRank Cloud |

如何更新知识库

手动更新

• 改 projects/<slug>/modules/*.md 的「最近一次重要变更」段：PR 作者
• 改 projects/<slug>/framework.md：项目 owner（季度审查）
• 改 INDEX.md、projects.json、iterations.json：知识库 owner

自动更新（git 提交 → 功能文档）

cd D:\SanQian.Xu\project-knowledge-base\scripts
.\gen-commit-doc.ps1 -ProjectSlug claude-devsprite   # 单项目
.\gen-commit-doc.ps1 -ProjectSlug ALL                # 全部项目

脚本行为：

• feat / fix / refactor / perf → 写入 commits/
• docs / chore / test / style → 跳过（不写入 commits/）
• 同 feature-slug 的提交 → 追加到已有功能文件（不新建）
• docs: / chore: 视为维护类变更，不进 commits/

详见 templates/commit-feature.md 的输出格式。

维护约定

• 路径风格：所有内部链接用 POSIX 风格（/ 而非 \）
• 命名风格：文件名 kebab-case 全小写 ASCII
• Frontmatter：每个 .md 顶部带 YAML frontmatter（用 --- 包围）
• 每文件一职责：一个模块一文件、一次功能交付一文件

知识库自身的变更

见 CHANGELOG.md。