Ver código fonte

chore(docs): 更新文档结构与内容,新增分支说明文件

- 修改 .gitignore,移除不必要的文件和目录。
- 更新 README.md,调整版本号并修正文中提及的功能名称。
- 新增 docs 目录,集中管理功能分支说明、开发备忘和设计笔记。
- 创建 shanchubutton 和 zhangjietiquxiufu 分支说明文件,详细描述各自功能与使用要求。
darknessomi 1 semana atrás
pai
commit
74187ccf63

+ 8 - 0
.agents/AGENTS.md

@@ -33,6 +33,14 @@ QMAI 是**长篇小说记忆型 AI 写作桌面系统**(Tauri 2 + React 19 + T
 
 小说相关逻辑优先放 `src/lib/novel/`,通过 `mod.ts` 导出;不要散落在 UI 组件里。
 
+## 文档放置
+
+功能分支说明、开发备忘、设计笔记一律写在 `docs/`,不要新建到仓库根目录。
+
+- 分支说明命名:`docs/<分支名>-分支说明.md`
+- 已有同类文件只改 `docs/` 里的副本,不要在根目录再写一份
+- `scripts/dev/notes/` 只留给脚本侧临时笔记,新的分支说明不要往那里放
+
 ## 数据与隔离原则
 
 - 本地存储:项目目录 = Markdown(章节正文)+ JSON(快照/状态)+ LanceDB(向量)

+ 0 - 16
.gitignore

@@ -28,22 +28,14 @@ yarn-error.log*
 # 测试与 test helpers 必须纳入版本控制,不在此忽略。
 
 # === 根目录文档(仅本地保留)===
-/docs/
-/AGENTS.md
 /PDD.MD
 /QM-QUAI.md
 /soul.md
 /ter
 /_fix_encoding.py
-CLAUDE.md
 de-ai-skill.md
 
 # === 中文命名文档/临时文件 ===
-提示词.md
-项目完成度分析报告.md
-soul文档软件更新分析.md
-jueseyizhixing分支说明.md
-xinjiangongzuohuihua.md
 diff_chapter.txt
 qmai-backup-*.zip
 QMaiWrite_*.zip
@@ -53,9 +45,6 @@ QMaiWrite_*.zip
 reasonix.toml
 QMdelete/
 tokenyouhua/
-De-AI-Prompt-Enhancer-Writer-Booster-SKILL-main/
-De-AI-Prompt-Enhancer-Writer-Booster-SKILL-main.zip
-.claude/
 .codegraph/
 
 # === IDE / 工具临时文件 ===
@@ -69,11 +58,6 @@ De-AI-Prompt-Enhancer-Writer-Booster-SKILL-main.zip
 .vscode/
 /.zed/
 
-# === 杂项 ===
-/1.txt
-/nul
-/xiufuzonghebug-分支说明.md
-/zed-design-standard.html
 
 # === 开发调试产物(勿提交根目录)===
 /test-mocks-*-report.json

+ 20 - 20
README.md

@@ -12,7 +12,7 @@
   <a href="https://github.com/Mochocyang/QMAI/releases">
     <img src="https://img.shields.io/github/v/release/Mochocyang/QMAI?style=flat-square" alt="Release" />
   </a>
-  <img src="https://img.shields.io/badge/version-2.2.32-blue?style=flat-square" alt="Version" />
+  <img src="https://img.shields.io/badge/version-3.2.12-blue?style=flat-square" alt="Version" />
   <img src="https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-blue?style=flat-square" alt="Platform" />
   <img src="https://img.shields.io/badge/license-GPL--3.0-blue?style=flat-square" alt="License" />
 </p>
@@ -34,7 +34,7 @@
 - 网文日更作者:保持长篇连载质量、防止人设崩坏
 - 小说策划者:管理世界观、势力关系、多线剧情
 - AI 辅助写作者:让大模型在长篇创作中持续可用
-- 学习仿写者:通过拆库拆解成熟作品的角色设定与文风
+- 学习仿写者:通过拆库拆解成熟作品的角色设定与文风
 
 ---
 <img width="1239" height="883" alt="image" src="https://github.com/user-attachments/assets/076740be-85ef-4503-842d-565c367aebdc" />
@@ -108,7 +108,7 @@
 - 时间线与关键事件
 - 动机、行为模式与代表性台词
 
-系统内置数十个预设角色视角范例(从费曼到鲁迅、从孙悟空到王阳明),用户可参照创建自己小说中的角色模版。也可以通过**拆库**从已有作品中提取角色,一键加入自定义灵魂库。
+系统内置数十个预设角色视角范例(从费曼到鲁迅、从孙悟空到王阳明),用户可参照创建自己小说中的角色模版。也可以通过**拆库**从已有作品中提取角色,一键加入自定义灵魂库。
 
 **角色认知系统:**
 
@@ -121,9 +121,9 @@
 
 ---
 
-### 📖 拆库(作品分析)
+### 📖 拆库(作品分析)
 
-拆库是青幕AI写作的特色功能,让你能够**拆解成熟作品的写作秘密**,并将其复用到自己的创作中。
+拆库是青幕AI写作的特色功能,让你能够**拆解成熟作品的写作秘密**,并将其复用到自己的创作中。
 
 **拆书工作流:**
 1. 导入小说作品(支持整本/多文件/章节范围选择)
@@ -136,21 +136,21 @@
 
 | 维度 | 说明 |
 |------|------|
-| 文风宪法 | 8-12 条带理由的硬性写作规则 |
-| 叙事视角 | 第几人称、视角切换规则 |
-| 对话风格 | 口语化程度、台词密度 |
-| 描写密度 | 环境/动作/心理描写的比重 |
-| 节奏控制 | 张弛节奏、信息投放速度 |
-| 情感处理 | 含蓄外露程度、共情强度 |
-| 用词偏好 | 书面/口语、长短句倾向 |
-| 段落结构 | 段落长度、过渡方式 |
-| 代表样本 | 多段原文片段佐证分析 |
+| 叙事密度 / 节奏 | 推进速度与信息投放节奏 |
+| 环境描写比重 | 具体实物 vs 抒情氛围的比重 |
+| 情绪呈现 | 动作外显 vs 内心独白,以及克制度 |
+| 句式与句长 | 长短句倾向、口语化程度 |
+| 比喻 / 通感密度 | 修辞出现频率与克制程度 |
+| 场景与时间过渡 | 转场和跳时的写法 |
+| 叙述视角与声音 | 人称、视角切换与叙述腔调 |
+| 对白风格 | 口语 / 毛边 / 潜台词 |
+| 点题 / 抒情习惯 | 段尾总结、点题与抒情的频率 |
 
 启用文风约束后,每次生成章节时会自动注入文风预设,保障全书风格统一。
 
-**拆库特性:**
+**拆库特性:**
 - 支持重新提取角色 / 重新提取文风
-- 后台运行:深度提取可后台执行,右下角浮层显示进度,完成后一键跳转结果
+- 后台运行:深度提取可后台执行,各任务进度显示在对应 Skill 页签内,完成后一键跳转结果
 - 别名匹配:角色光环支持拼音模糊匹配和简繁转换,昵称也能命中角色设定
 
 ---
@@ -223,7 +223,7 @@
 | AI 生成错误内容污染后续 | 草稿/正式章节分离 + 人工确认后才入库 |
 | 大纲执行偏移 | 大纲一致性审查 + 上下文强制注入大纲规则 |
 | 生成内容 AI 味重 | 去AI化改写(De-AI)+ 项目灵魂风格控制 + 作品文风约束 |
-| 不知道如何写好某种文风 | 拆库提取成熟作品的 9 维文风,直接复用 |
+| 不知道如何写好某种文风 | 拆库提取成熟作品的 9 维文风,直接复用 |
 | 设定散落难以追踪 | 图谱可视化 + 结构化记忆 + 全文搜索 |
 | 长章节超出模型上下文 | 发送前按模型真实输入上限自动裁剪并重试 |
 
@@ -364,7 +364,7 @@ macOS 暂不支持应用内自动更新,新版本请手动从 Releases 下载
 ### 基本使用流程
 
 1. **新建小说项目**:指定项目名称、题材、目标字数
-2. **导入或生成大纲**:导入已有大纲,或通过 AI 生成;也可从拆库提取文风作为风格约束
+2. **导入或生成大纲**:导入已有大纲,或通过 AI 生成;也可从拆库提取文风作为风格约束
 3. **配置模型**:在设置中配置 LLM API 地址和密钥;可设置「默认模型」统筹后台任务
 4. **开始写作**:在 AI 对话区输入写作指令(如"继续写第 30 章")
 5. **审阅草稿**:查看生成结果,可编辑、重写或审稿
@@ -384,7 +384,7 @@ QMAI/
 │   │   ├── editor/               # 编辑器与阅读器
 │   │   ├── graph/                # 图谱视图
 │   │   ├── layout/               # 布局组件(含使用说明入口)
-│   │   ├── novel/                # 小说功能组件(灵魂、认知、伏笔、记忆、拆库等)
+│   │   ├── novel/                # 小说功能组件(灵魂、认知、伏笔、记忆、拆库等)
 │   │   ├── review/               # 审查中心
 │   │   ├── search/               # 搜索视图
 │   │   ├── settings/             # 设置面板(模型、数据管理、界面等)
@@ -392,7 +392,7 @@ QMAI/
 │   │   └── ui/                   # 通用 UI 组件
 │   ├── lib/                      # 业务逻辑库
 │   │   ├── novel/                # 小说核心模块
-│   │   │   ├── book-analysis/    # 拆库(角色提取、文风提取、别名匹配等)
+│   │   │   ├── book-analysis/    # 拆库(角色提取、文风提取、别名匹配等)
 │   │   │   ├── context-engine.ts # 上下文引擎
 │   │   │   ├── chapter-ingest.ts # 章节摄取
 │   │   │   ├── review-adapter.ts # 审查适配器(含角色一致性)

+ 12 - 0
docs/README.md

@@ -0,0 +1,12 @@
+# docs
+
+仓库文档目录。功能分支说明、开发备忘、设计笔记一律放这里,不要堆在仓库根目录。
+
+## 分支说明
+
+每个功能分支一份,命名:`<分支名>-分支说明.md`。
+
+已有:
+
+- [shanchubutton-分支说明.md](./shanchubutton-分支说明.md)
+- [zhangjietiquxiufu-分支说明.md](./zhangjietiquxiufu-分支说明.md)

+ 0 - 0
shanchubutton-分支说明.md → docs/shanchubutton-分支说明.md


+ 0 - 0
zhangjietiquxiufu-分支说明.md → docs/zhangjietiquxiufu-分支说明.md