Imported from yongc2025/NovelFactory (
AGENTS.md). Install upstream withnpx skills add yongc2025/NovelFactory. Copyright stays with the author.
NovelFactory AI Agent 操作手册
1. 核心定位
NovelFactory — 一个人的自动化小说工厂 从灵感出发,通过 AI 角色协作生成全平台内容(小红书/番茄/短剧)。用户负责审核决策,AI 负责规模化生产。
2. 行为禁令(红线)
- 禁止提交密钥:严禁在代码或文档中提交任何明文 API Key (使用
.env)。 - 禁止无任务开发:严禁在没有 Task Bundle(
tasks/)或明确验收标准时编写核心逻辑。 - 禁止越权重构:严禁“顺手”重构大范围代码,除非任务明确要求修复技术债务。
- 禁止跳过规范:严禁违反下述硬性指标,超标必须重构。
3. 黄金路径(工作流)
- 锁定上下文:读取
tasks/INDEX.md确定当前任务。 - 同步进度:更新
docs/02_任务看板.md和docs/03_开发决策集.md。 - 读后写:修改代码前必须先读取相关文件,确保理解当前代码逻辑。
- 验证闭环:每完成一个子任务,必须进行验证并同步状态。
4. 编码硬性限制(强制执行)
完整规范见 docs/coding-standards.md。AI 会在每次对话中实时检查以下阈值。
4.1 后端 Python 约束
| 指标 | 警告阈值 | 熔断上限 | 超标处理 |
|---|---|---|---|
| 文件行数 | 300 行 | 500 行 | 500+ 必须拆分模块 |
| 函数行数 | 30 行 | 50 行 | 50+ 必须提取子函数 |
| 参数个数 | 4 个 | 6 个 | 6+ 强制使用 Pydantic/Dataclass |
| 嵌套层级 | 3 层 | 4 层 | 4+ 强制使用 Guard Clause (早返回) |
| 圈复杂度 | 8 | 12 | 12+ 必须重构逻辑 |
| 强制要求 | - | - | 必须包含 Type Hints 和 Google Style Docstring |
4.2 前端 Vue/TypeScript 约束
| 指标 | 警告阈值 | 熔断上限 | 超标处理 |
|---|---|---|---|
| .vue 总行数 | 200 行 | 350 行 | 350+ 必须拆分组件 |
| 行数 | 150 行 | 250 行 | 250+ 提取至 Composable |
| 组件内状态 | 10 个 | 15 个 | 15+ 说明组件职责过载 |
| any 使用 | 0 个 | 0 个 | 禁用 any,使用 unknown + 类型推断 |
| 强制要求 | - | - | <script setup lang="ts"> |
5. 技术栈与角色快速查询
- 后端: Python 3.11+ / FastAPI / SQLAlchemy (SQLite)
- 前端: Vue 3 / Vite / Ant Design Vue 4.x / Pinia
- LLM 路由:
pro(DeepSeek-V4-Pro): 用于复杂逻辑分析、大纲编剧、世界观构建。flash(DeepSeek-V4-Flash): 用于正文生成、场景编剧、审校。
- 存储方案: JSON (项目配置) / SQLite + FTS5 (结构化及检索数据)。
