Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 65 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,10 @@ novel init my-novel --ai cursor # Cursor
```

**七步方法论流程**:
1. `/constitution` → 2. `/specify` → 3. `/clarify` →
4. `/plan` → 5. `/tasks` → 6. `/write` → 7. `/analyze`

```
1. /constitution → 2. /specify → 3. /clarify → 4. /plan → 5. /tasks → 6. /write → 7. /analyze
```

> 📚 **详细安装说明**:[docs/installation.md](docs/installation.md)
> 📖 **完整工作流程**:[docs/workflow.md](docs/workflow.md)
Expand All @@ -80,39 +82,39 @@ novel upgrade --ai claude

### 命名空间说明

| AI 平台 | 命令格式 | 示例 |
|---------|----------|------|
| AI 平台 | 命令格式 | 示例 |
| --------------- | --------------- | -------------- |
| **Claude Code** | `/novel.命令名` | `/novel.write` |
| **Gemini CLI** | `/novel:命令名` | `/novel:write` |
| **Codex CLI** | `/novel-命令名` | `/novel-write` |
| **其他平台** | `/命令名` | `/write` |
| **Gemini CLI** | `/novel:命令名` | `/novel:write` |
| **Codex CLI** | `/novel-命令名` | `/novel-write` |
| **其他平台** | `/命令名` | `/write` |

> 💡 下表使用通用格式,实际使用时请根据您的 AI 平台添加相应前缀
> 📖 **详细命令对照**:[docs/ai-platform-commands.md](docs/ai-platform-commands.md)

### 七步方法论

| 命令 | 描述 | 何时使用 |
|------|------|----------|
| `/constitution` | 创作宪法 | 项目开始,定义核心创作原则 |
| `/specify` | 故事规格 | 像 PRD 一样定义故事需求 |
| `/clarify` | 澄清决策 | 通过 5 个问题明确模糊点 |
| `/plan` | 创作计划 | 制定章节结构和技术方案 |
| `/tasks` | 任务分解 | 生成可执行的任务清单 |
| `/write` | 章节写作 | 基于任务清单进行创作 |
| `/analyze` | 综合验证 | 智能双模式:框架分析/内容分析 |
| 命令 | 描述 | 何时使用 |
| --------------- | -------- | ----------------------------- |
| `/constitution` | 创作宪法 | 项目开始,定义核心创作原则 |
| `/specify` | 故事规格 | 像 PRD 一样定义故事需求 |
| `/clarify` | 澄清决策 | 通过 5 个问题明确模糊点 |
| `/plan` | 创作计划 | 制定章节结构和技术方案 |
| `/tasks` | 任务分解 | 生成可执行的任务清单 |
| `/write` | 章节写作 | 基于任务清单进行创作 |
| `/analyze` | 综合验证 | 智能双模式:框架分析/内容分析 |

### 追踪与验证

| 命令 | 描述 | 何时使用 |
|------|------|----------|
| `/track-init` | 初始化追踪 | 首次使用(只需一次) |
| `/checklist` | 质量检查清单 ⭐ | 规格验证(写作前)+ 内容扫描(写作后) |
| `/track` | 综合追踪 | 每完成一章后 |
| `/plot-check` | 情节检查 | 每 5-10 章定期检查 |
| `/timeline` | 时间线管理 | 重要事件后 |
| `/relations` | 关系追踪 | 角色关系变化时 |
| `/world-check` | 世界观检查 | 新设定出现后 |
| 命令 | 描述 | 何时使用 |
| -------------- | --------------- | -------------------------------------- |
| `/track-init` | 初始化追踪 | 首次使用(只需一次) |
| `/checklist` | 质量检查清单 ⭐ | 规格验证(写作前)+ 内容扫描(写作后) |
| `/track` | 综合追踪 | 每完成一章后 |
| `/plot-check` | 情节检查 | 每 5-10 章定期检查 |
| `/timeline` | 时间线管理 | 重要事件后 |
| `/relations` | 关系追踪 | 角色关系变化时 |
| `/world-check` | 世界观检查 | 新设定出现后 |

> 📖 **详细命令说明**:[docs/commands.md](docs/commands.md) - 包含每个命令的详细用法、参数和最佳实践

Expand Down Expand Up @@ -144,21 +146,21 @@ my-novel/

## 🤖 支持的 AI 助手

| AI 工具 | 说明 | 状态 |
|---------|------|------|
| **Claude Code** | Anthropic 的 AI 助手 | ✅ 推荐 |
| **Cursor** | AI 代码编辑器 | ✅ 完整支持 |
| **Gemini CLI** | Google 的 AI 助手 | ✅ TOML 格式 |
| **Windsurf** | Codeium 的 AI 编辑器 | ✅ 完整支持 |
| **Roo Code** | AI 编程助手 | ✅ 完整支持 |
| **GitHub Copilot** | GitHub 的 AI 编程助手 | ✅ 完整支持 |
| **Qwen Code** | 阿里通义千问代码助手 | ✅ TOML 格式 |
| **OpenCode** | 开源 AI 编程工具 | ✅ 完整支持 |
| **Codex CLI** | AI 编程助手 | ✅ 完整支持 |
| **Kilo Code** | AI 编程工具 | ✅ 完整支持 |
| **Auggie CLI** | AI 开发助手 | ✅ 完整支持 |
| **CodeBuddy** | AI 编程伙伴 | ✅ 完整支持 |
| **Amazon Q Developer** | AWS 的 AI 开发助手 | ✅ 完整支持 |
| AI 工具 | 说明 | 状态 |
| ---------------------- | --------------------- | ------------ |
| **Claude Code** | Anthropic 的 AI 助手 | ✅ 推荐 |
| **Cursor** | AI 代码编辑器 | ✅ 完整支持 |
| **Gemini CLI** | Google 的 AI 助手 | ✅ TOML 格式 |
| **Windsurf** | Codeium 的 AI 编辑器 | ✅ 完整支持 |
| **Roo Code** | AI 编程助手 | ✅ 完整支持 |
| **GitHub Copilot** | GitHub 的 AI 编程助手 | ✅ 完整支持 |
| **Qwen Code** | 阿里通义千问代码助手 | ✅ TOML 格式 |
| **OpenCode** | 开源 AI 编程工具 | ✅ 完整支持 |
| **Codex CLI** | AI 编程助手 | ✅ 完整支持 |
| **Kilo Code** | AI 编程工具 | ✅ 完整支持 |
| **Auggie CLI** | AI 开发助手 | ✅ 完整支持 |
| **CodeBuddy** | AI 编程伙伴 | ✅ 完整支持 |
| **Amazon Q Developer** | AWS 的 AI 开发助手 | ✅ 完整支持 |

> 💡 使用 `novel init --all` 可以同时为所有 AI 工具生成配置

Expand All @@ -174,8 +176,9 @@ novel init my-novel [选项]
```

**常用选项**:

- `--here` - 在当前目录初始化
- `--ai <type>` - 选择 AI 平台(claude/gemini/cursor等
- `--ai <type>` - 选择 AI 平台(claude/gemini/cursor 等
- `--with-experts` - 包含专家模式
- `--plugins <names>` - 预装插件(逗号分隔)
- `--all` - 生成所有 AI 平台配置
Expand Down Expand Up @@ -205,18 +208,21 @@ novel check # 检查项目配置和状态
## 📖 文档索引

### 核心文档

- **[命令详解](docs/commands.md)** - 所有斜杠命令的详细用法、参数和最佳实践
- **[工作流程](docs/workflow.md)** - 完整的创作流程说明
- **[写作方法](docs/writing-methods.md)** - 6种经典写作方法详解
- **[写作方法](docs/writing-methods.md)** - 6 种经典写作方法详解
- **[最佳实践](docs/best-practices.md)** - 实战经验和高级技巧

### 进阶文档

- **[实战指南](docs/writing/practical-guide.md)** - 基于真实案例的 SDD 应用
- **[升级指南](docs/upgrade-guide.md)** - 版本升级说明和迁移指南
- **[安装指南](docs/installation.md)** - 详细安装步骤
- **[字数统计](docs/word-count-guide.md)** - 中文字数统计最佳实践

### 插件与扩展

- **真实人声插件** - `novel plugins add authentic-voice`
- 编辑 `.specify/memory/personal-voice.md` 配置个人语料
- 使用 `/authentic-voice` 创作,`/authenticity-audit` 自查
Expand All @@ -230,6 +236,7 @@ novel check # 检查项目配置和状态
查看完整的更新日志:**[CHANGELOG.md](CHANGELOG.md)**

**最新版本亮点**:

- v0.15.0 - 多平台命令格式优化
- v0.14.2 - 中文字数统计修复
- v0.12.2 - Claude Code 增强层
Expand All @@ -252,18 +259,18 @@ WordFlowLab 围绕 AI 辅助小说创作展开多维度探索,采用不同方

### 方法论探索系列

| 项目 | 方法论 | 技术特点 | 适用场景 |
|------|--------|----------|----------|
| **[Novel-Writer](https://github.com/wordflowlab/novel-writer)** ⭐ | Spec-Kit | 寄生斜杠命令,七步方法论 | 适合多平台用户,跨 13 个 AI 工具 |
| **[Article-Writer](https://github.com/wordflowlab/article-writer)** 🆕 | Spec-Kit | 九步写作流程,工作区管理 | 公众号/自媒体文章创作,降低 AI 味 |
| **[Novel-Writer-OpenSpec](https://github.com/wordflowlab/novel-writer-openspec)** | OpenSpec | 寄生斜杠命令,规格分离管理(specs/ + changes/) | 适合需要 OpenSpec 规格化管理 |
| **[Novel-Writer-Skills](https://github.com/wordflowlab/novel-writer-skills)** | Spec-Kit + Agent Skills | 寄生斜杠命令,支持 Claude Code Agent Skills | 专为 Claude Code 优化 |
| 项目 | 方法论 | 技术特点 | 适用场景 |
| --------------------------------------------------------------------------------- | ----------------------- | ----------------------------------------------- | --------------------------------- |
| **[Novel-Writer](https://github.com/wordflowlab/novel-writer)** ⭐ | Spec-Kit | 寄生斜杠命令,七步方法论 | 适合多平台用户,跨 13 个 AI 工具 |
| **[Article-Writer](https://github.com/wordflowlab/article-writer)** 🆕 | Spec-Kit | 九步写作流程,工作区管理 | 公众号/自媒体文章创作,降低 AI 味 |
| **[Novel-Writer-OpenSpec](https://github.com/wordflowlab/novel-writer-openspec)** | OpenSpec | 寄生斜杠命令,规格分离管理(specs/ + changes/) | 适合需要 OpenSpec 规格化管理 |
| **[Novel-Writer-Skills](https://github.com/wordflowlab/novel-writer-skills)** | Spec-Kit + Agent Skills | 寄生斜杠命令,支持 Claude Code Agent Skills | 专为 Claude Code 优化 |

### 工具实现系列

| 项目 | 类型 | 技术基础 | 说明 |
|------|------|----------|------|
| **[WriteFlow](https://github.com/wordflowlab/writeflow)** | CLI 工具 | 模仿 Claude Code 架构 | 独立 CLI,为技术型作家设计 |
| 项目 | 类型 | 技术基础 | 说明 |
| ----------------------------------------------------------- | ----------- | ----------------------------------------------- | -------------------------- |
| **[WriteFlow](https://github.com/wordflowlab/writeflow)** | CLI 工具 | 模仿 Claude Code 架构 | 独立 CLI,为技术型作家设计 |
| **[NovelWeave](https://github.com/wordflowlab/novelweave)** | VSCode 扩展 | Fork: Cline → Roo Code → Kilo Code → NovelWeave | 可视化小说编辑器,星尘织梦 |

### 技术演进路径
Expand All @@ -284,14 +291,15 @@ VSCode 扩展分支:

根据您的经验背景选择合适的工具:

| 用户类型 | 推荐项目 | 理由 |
|---------|---------|------|
| 🌟 **新手入门** | [NovelWeave](https://github.com/wordflowlab/novelweave) | 可视化编辑器,VSCode 扩展,最易上手 |
| 用户类型 | 推荐项目 | 理由 |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------- |
| 🌟 **新手入门** | [NovelWeave](https://github.com/wordflowlab/novelweave) | 可视化编辑器,VSCode 扩展,最易上手 |
| 💻 **有编程基础<br>无小说经验** | [Novel-Writer](https://github.com/wordflowlab/novel-writer) <br> [Novel-Writer-Skills](https://github.com/wordflowlab/novel-writer-skills) | 七步方法论引导创作流程<br>Skills 版适合 Claude Code 用户 |
| 📚 **有编程基础<br>有小说经验** | [Novel-Writer-OpenSpec](https://github.com/wordflowlab/novel-writer-openspec) | OpenSpec 规格化管理<br>适合系统化创作和团队协作 |
| 🚀 **技术探索者<br>可贡献 PR** | [WriteFlow](https://github.com/wordflowlab/writeflow) | CLI 工具开发探索<br>欢迎贡献代码和想法 |
| 📚 **有编程基础<br>有小说经验** | [Novel-Writer-OpenSpec](https://github.com/wordflowlab/novel-writer-openspec) | OpenSpec 规格化管理<br>适合系统化创作和团队协作 |
| 🚀 **技术探索者<br>可贡献 PR** | [WriteFlow](https://github.com/wordflowlab/writeflow) | CLI 工具开发探索<br>欢迎贡献代码和想法 |

**快速决策**:

- **完全新手** → NovelWeave(可视化最友好)
- **用 Claude Code** → Novel-Writer-Skills(深度集成 Agent Skills)
- **跨多个 AI 工具** → Novel-Writer(支持 13 个平台)
Expand All @@ -302,7 +310,7 @@ VSCode 扩展分支:

## 🙏 致谢

本项目基于 [Spec Kit](https://github.com/sublayerapp/spec-kit) 架构设计,特此感谢!
本项目基于 [Spec Kit](https://github.com/github/spec-kit) 架构设计,特此感谢!

---

Expand Down