WikiFlow 驱动的代码仓库
这是一个由 WikiFlow 驱动的代码仓库。了解 WikiFlow 的设计理念有助于理解本仓库的管理方式。
WikiFlow 是什么？
WikiFlow 是一个文档驱动的 AI 工作流协议。它通过文档和代码分离的方式，让人类专注于业务逻辑和系统设计，让 AI 专注于代码实现。
核心理念
文档与代码分离
本仓库采用文档代码分离模式：
- 文档仓库：包含所有的需求文档、设计文档、API 文档、决策记录等
- 由团队/个人管理
- 是核心资产（知识产权）
- 人类通过文档与 AI 协作
- 代码仓库（本仓库）：包含所有的源代码、测试代码、构建脚本
- 由 AI 主要管理
- 也可以通过传统的 Git 工作流管理
- 人类不需要深入了解实现细节
人管文档，AI 管代码
在这种模式下：
人类的职责：
- ✅ 在文档仓库中制定业务需求
- ✅ 编写和维护设计文档
- ✅ 审查和批准开发计划
- ✅ 查阅 Wiki 了解系统架构
AI 的职责：
- ✅ 根据文档生成代码
- ✅ 修改和优化代码实现
- ✅ 编写测试代码
- ✅ 修复 bug
代码是黑盒
对本仓库来说：
- 代码实现细节可以随时变化
- 只要功能符合文档定义，就是正确的
- AI 有完全的自由度优化和重构代码
- 人类不需要关心代码风格和实现方式
如何与文档仓库协作
关联机制
本仓库通过配置文件与文档仓库关联。配置文件定义在文档仓库的 .wikiflow/config.json 中：
{
"paths": {
"code": "../wikiflow" // 指向本代码仓库
}
}
开发流程
典型的开发流程：
- 查阅文档：在文档仓库的
docs/wiki/current/ 中查看相关文档
- 制定计划：在文档仓库执行
/wf-plan "功能名称"
- 生成代码：在文档仓库执行
/wf-do（AI 自动切换到本仓库修改代码）
- 同步文档：在文档仓库执行
/wf-finish（更新 Wiki 知识库）
跨仓库操作
当你需要修改代码时：
- 在文档仓库执行
/wf-do
- WikiFlow 会自动切换到本代码仓库
- AI 完成代码修改后，自动切回文档仓库
当你需要查看文档时：
- 在本仓库无法直接编辑 Wiki
- 需要切换到文档仓库进行文档操作
仓库职责
本仓库负责（代码仓库）
✅ 允许的操作：
- 源代码的编写和修改
- 测试代码的编写和执行
- 构建和部署脚本
- 代码版本管理（Git）
- 代码优化和重构
❌ 不允许的操作：
- 编辑 Wiki 文档
- 修改开发计划（spec.md、tasks.md）
- 执行 WikiFlow 工作流（wf-plan、wf-finish 等）
文档仓库负责
✅ 允许的操作：
- 编写和维护文档
- 管理开发计划
- 执行 WikiFlow 工作流
- Wiki 知识库管理
❌ 不允许的操作：
常见问题
Q: 我可以直接修改代码吗？
A: 可以。WikiFlow 不禁止人类直接修改代码，但推荐通过文档驱动的方式：
- 通过文档仓库制定计划
- 让 AI 根据计划生成代码
- 这样可以保持文档和代码的同步
Q: 我可以在本仓库编辑 Wiki 吗？
A: 不可以。Wiki 必须在文档仓库中编辑：
- 本仓库是代码仓库，不包含 Wiki
- 需要切换到文档仓库进行文档操作
- WikiFlow 会自动处理跨仓库协作
Q: 如何了解系统的设计？
A: 查阅文档仓库的 Wiki：
docs/wiki/current/ - 当前实现docs/wiki/decisions/ - 决策记录docs/changes/active/ - 开发中的变更
Q: 代码和文档不一致怎么办？
A: 以文档为准：
- Wiki 是当前真相
- 如果代码和文档不一致，说明代码需要修改
- 执行
/wf-do 让 AI 根据文档修正代码
相关链接
版本管理
本仓库使用 Git 进行版本管理。与文档仓库的协作通过以下方式：
- 独立版本管理：代码仓库和文档仓库分别管理版本
- 变更关联：通过 commit message 引用文档仓库的变更编号
- 发布同步：发布时在文档仓库记录版本信息
最后更新：2026-04-24
维护者：WikiFlow 自动化工作流