docs/ 用来承接根目录之外的设计文档、阶段检查点、模块计划和历史归档,避免方案文档继续散落在仓库根目录。
根目录只保留下面几类文件:
- 项目入口与对外说明:
README.md - 路线图与执行主清单:
TASK.md - 协作与工程约束:
AGENTS.md - Monorepo 与工具链配置:
package.json、pnpm-workspace.yaml、tsconfig.base.json、.env.example
其余设计稿、阶段总结、模块计划、历史规格,统一进入 docs/ 对应子目录。
用于记录阶段性检查点、架构迁移里程碑、进度审计和对照说明。
- Chapter Editor V2 Progress
- Prompt Governance Audit 2026-05-08
- LLM Schema Refactor Checkpoint
- Windows Desktop Installer Manual Checklist
用于放仍有执行价值的模块计划、工作拆解和产品推进方案。
- Assistant UI Plan
- Chapter Editor V2 Plan
- Character Resource Ledger Plan
- Prompt Workbench, Context and Step Runtime Plan
- Auto Director Execution Plane Isolation Plan
- Director Mode Module and State Refactor Checklist
用于放系统设计、模块接口、产品机制和领域建模说明。
- Style Engine v1
- Style Engine Prompt Compiler v1
- Style Engine Boundary and PRD v2
- World Management v2
- World Story Interface v1
承接横切架构说明与工程约定(不改变根目录对外入口)。
- Backend testing:后端
node:test脚本的运行方式与目录约定。
用于沉淀长期项目知识,帮助未来开发者和 AI Agent 理解关键架构决策、工作流边界、运行协议、调试经验和产品设计依据。
Wiki 不替代计划、检查点或发布说明:
-
docs/wiki记录稳定规则和原因。 -
docs/plans记录仍有执行价值的方案和工作拆解。 -
docs/checkpoints记录阶段性状态、迁移里程碑和审计对照。 -
docs/design记录模块设计、领域建模和产品机制。 -
docs/releases记录用户可见变化。
用于放完整的用户可见版本更新说明与发布历史;根 README.md 只保留最新一次更新,本目录负责承接完整历史。
用于放历史初始化方案、已不再作为主执行依据但仍需要保留的资料。
- 统一使用小写英文文件名,单词之间用
-连接。 - 计划类文档优先放到
docs/plans/。 - 架构调整、进度校验、迁移检查点优先放到
docs/checkpoints/。 - 模块设计、数据模型、交互机制优先放到
docs/design/。 - 长期架构规则、工作流边界、调试经验和产品设计依据优先放到
docs/wiki/。 - 用户可见版本更新历史优先放到
docs/releases/。 - 已废弃、乱码、明显被当前发布事实取代但需要留档的方案放到
docs/archive/outdated/。
- 新增文档时,先判断是否真的需要留在根目录;默认答案应当是“不需要”。
- 新增或修改核心工作流、Prompt、RAG、任务状态、自动导演、章节生产或重要调试结论时,先判断是否产生稳定 Wiki 价值。
- Wiki 页面应解释长期规则和原因,不写成文件修改列表、临时 TODO 或 release notes 复制品。
- 文档迁移后,如根
README.md或其他入口文档里有引用,应同步更新路径。 TASK.md负责“当前主路线与优先级”,不替代设计文档;设计细节应沉到docs/。- 根
README.md的更新说明只保留最新一次;完整历史统一维护在docs/releases/release-notes.md。