Skip to content

Commit 39a471e

Browse files
committed
docs: 补齐总导航/知识库/版本索引,新增 templates README 与 docs-check 豁免清单
1 parent 47a2c2c commit 39a471e

5 files changed

Lines changed: 71 additions & 0 deletions

File tree

‎docs/.docscheckignore‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# docs-check.mjs 豁免清单
2+
# 每行一个 glob 模式(匹配相对 docs/ 的路径),命中文件跳过链接/索引/命名检查。
3+
# 用途:历史快照文档保留原貌(见 versions/README.md"历史文档链接说明"),不纳入门禁。
4+
# 注意:豁免是例外而非常态,新文档一律不得加入此清单。
5+
6+
# 历史版本文档(docs 重组前撰写,内部链接指向已删除的 phase0~phase6/旧目录,保留原貌)
7+
versions/v0.3.0.md
8+
versions/v0.4.0.md
9+
versions/v0.5.0.md
10+
versions/v0.6.0.md
11+
versions/v0.7.0.md
12+
versions/v0.8.0.md
13+
versions/v0.9.0.md
14+
versions/v0.10.0.md
15+
versions/v0.11.0.md
16+
# v0.27.0 引用未沉淀的 v1.0.0 规划文档(预期缺失)
17+
versions/v0.27.0.md
18+
# v0.23.0 / v0.34.0 合集(内部链接为历史上下文引用)
19+
versions/v0.23.0/**
20+
versions/v0.34.0/**

‎docs/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,10 @@ ADR、头脑风暴、估算、数据库迁移、知识卡片、MVP 画布、复
117117

118118
已实施完成的文档按日快照归档(`YYYY-MM-DD/`),技术债清单滚动维护(最新归档为唯一权威)。机制见 [archive/README.md](./archive/README.md) 与 [归档模板](./templates/archive-template.md)。
119119

120+
## 🧰 docs-starter-kit/ — 新项目文档骨架
121+
122+
从本项目提炼的**通用化文档模板树**(standards/templates/adr/knowledge/versions/archive + docs-check 脚本),不含项目特有内容,可直接复制到新项目使用。启用指南见 [docs-starter-kit/README.md](../docs-starter-kit/README.md)。
123+
120124
## 📚 knowledge/ — 知识库
121125

122126
踩坑记录 / 技术方案 / 学习笔记,按 [知识管理规范](./standards/knowledge-management.md) 组织。完整索引见 [knowledge/index.md](./knowledge/index.md)。

‎docs/knowledge/index.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
| 日期 | 标题 | 标签 |
88
|------|------|------|
9+
| 2026-08-07 | [笔记页「Failed to fetch dynamically imported module」:ELECTRON_BUILD 使 dev server 预构建依赖持续 504](./bugs/2026-08-vite-outdated-optimize-dep-dynamic-import-fail.md) | #Vite #optimizeDeps #ELECTRON_BUILD #动态导入 #base路径 #electron:dev |
10+
| 2026-08-07 | [笔记页左/上「黑条」:FunctionalOverlay 面板渐变背景依赖的 CSS 变量未全局定义](./bugs/2026-08-dive-css-vars-missing-panel-transparent.md) | #CSS变量 #按需加载 #FunctionalOverlay #面板背景 #主题变量 |
11+
| 2026-08-04 | [内测反馈五连修:页面切换不渲染、MCP 复制失败、构建后无音频、预设管理缺陷、番茄钟一屏适配](./bugs/2026-08-beta-feedback-five-fixes.md) | #3D导航 #竞态 #Electron #剪贴板 #file协议 #资源路径 #预设CRUD #响应式 |
912
| 2026-08-04 | [课堂真流式 ASR 永不激活:设置页缺失"启用本地语音识别"开关,enabled 恒为 false](./bugs/2026-08-streaming-asr-enable-toggle-missing.md) | #ASR #真流式 #设置页 #IPC死代码 #功能闸门 |
1013
| 2026-08-04 | [课堂助手生产包报「无法获取音频,启动失败」:file:// 下 AudioWorklet 模块加载失败且无降级](./bugs/2026-08-classroom-asr-file-protocol-worklet-load-failure.md) | #ASR #AudioWorklet #file协议 #降级兜底 #课堂助手 |
1114
| 2026-08-04 | [深色模式 3D 场景不渲染:双 EffectComposer 以 renderPriority=1 互相抢占渲染权](./bugs/2026-08-dark-mode-dual-effectcomposer-render-takeover.md) | #R3F #EffectComposer #后处理 #renderPriority #深色模式 #3D渲染 |
@@ -33,6 +36,12 @@
3336
| 2026-08-01 | [熵减性能深度分析与优化路线图](./solutions/2026-08-performance-analysis-optimization-roadmap.md) | #性能分析 #内存泄漏 #重渲染 #3D性能 #基准测试 |
3437
| 2026-07-31 | [安装包分发加速:CDN 接入方案与下载源可切换设计](./solutions/2026-07-installer-cdn-distribution.md) | #CDN #阿里云 #安装包分发 #下载加速 |
3538

39+
## 📖 analysis/ — 机制分析
40+
41+
| 日期 | 标题 | 标签 |
42+
|------|------|------|
43+
| 2026-08-01 | [熵减功能模块科学机制分析](./learning-mechanisms-analysis.md) | #学习科学 #心理学机制 #脑科学 #机制缺口 |
44+
3645
## 🧠 learnings/ — 学习笔记
3746

3847
_(暂无)_

‎docs/templates/README.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# 文档模板索引
2+
3+
> 新文档一律从模板复制,保持格式统一。选择指南见下表。
4+
5+
## 模板清单
6+
7+
| 模板 | 何时使用 | 产出位置 |
8+
|------|---------|---------|
9+
| [adr-template.md](./adr-template.md) | 做出重要技术/架构决策时 | `docs/adr/ADR-XXX-*.md` |
10+
| [prd-template.md](./prd-template.md) | 新功能立项,需要完整需求规格 | `docs/product/` |
11+
| [brainstorm-template.md](./brainstorm-template.md) | 需求发散、创意收集阶段 | `docs/Foresight/` |
12+
| [mvp-canvas-template.md](./mvp-canvas-template.md) | 用一张画布快速验证产品构想(按需启用) | `docs/product/` |
13+
| [estimation-template.md](./estimation-template.md) | 排期/工作量估算(按需启用) | `docs/Foresight/` |
14+
| [knowledge-card-template.md](./knowledge-card-template.md) | 沉淀踩坑记录/技术方案/学习笔记/最佳实践 | `docs/knowledge/bugs|solutions|learnings/` |
15+
| [postmortem-template.md](./postmortem-template.md) | 事故/问题复盘 | `docs/knowledge/bugs/` 或 `docs/archive/` |
16+
| [release-checklist.md](./release-checklist.md) | 发版前逐项检查 | 发版流程随附 |
17+
| [sprint-review-template.md](./sprint-review-template.md) | 迭代周期回顾 | `docs/versions/` |
18+
| [third-party-eval-template.md](./third-party-eval-template.md) | 评估第三方服务/依赖选型 | `docs/Foresight/` |
19+
| [db-migration-template.md](./db-migration-template.md) | 数据库迁移设计 | `docs/versions/` 或随迁移 PR |
20+
| [archive-template.md](./archive-template.md) | 归档日索引与快照 | `docs/archive/YYYY-MM-DD/` |
21+
22+
## 选择指南(速查)
23+
24+
```
25+
新功能立项 → prd-template
26+
技术选型/设计决策 → adr-template
27+
创意发散/方向探讨 → brainstorm-template
28+
踩坑/方案沉淀 → knowledge-card-template
29+
发版准备 → release-checklist
30+
事故复盘 → postmortem-template
31+
```
32+
33+
## 维护规则
34+
35+
- 模板与 [文档编写规范](../standards/documentation.md) 保持一致;规范变更时同步更新模板
36+
- 模板文件保持通用性:禁止写入项目特有内容(品牌名、具体功能等)
37+
- 新增模板时同步更新本索引

‎docs/versions/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
- v0.12.0 ~ v0.22.0
2828
- v0.24.0 ~ v0.26.0
2929
- v0.28.0 ~ v0.33.0
30+
- v0.35.0 ~ v0.35.2
3031

3132
## 历史文档链接说明
3233

0 commit comments

Comments
 (0)