面向文档的AI协作工作流

一个让AI成为项目长期合作伙伴的工作流，解决上下文丢失、任务断裂和知识传递困难的问题。

🎯 为什么选择这个工作流？

解决的核心问题

• 上下文丢失 - AI无法跨会话保持项目记忆
• 任务断裂 - 中断后工作难以无缝衔接
• 知识传递困难 - 项目特定信息无法有效传递给AI

核心优势

| 传统AI协作 | 文档驱动AI协作 | |------------|---------------| | 😫 每次重新解释 | 😊 AI主动获取上下文 | | 😟 会话中断状态丢失 | 🚀 文档记录完整历史 | | 🤖 通用AI回复 | 🎯 项目定制化服务 | | 🔄 重复劳动 | 📈 知识持续积累 |

🚀 快速开始

方式一：全局安装（推荐）

# 全局安装
npm install -g document-driven-ai-workflow

# 验证安装
docs --help

方式二：项目级安装

# 在你的项目中
npm install document-driven-ai-workflow

# 使用 npx 运行
npx docs --help

方式三：直接下载

# 克隆仓库
git clone https://github.com/zego-delivery-toolkit/document-driven-ai-workflow.git
cd document-driven-ai-workflow

# 运行演示
npm run demo

📋 基本使用

1. 初始化项目

# 在你的项目根目录
docs init  # 创建文档目录结构

2. 创建项目上下文

docs:create context "项目概览"
docs:create context "技术架构"
docs:create context "开发规范"

3. 开始AI协作

现在你可以这样与AI协作：

你: 帮我在项目中添加用户管理功能
AI: 正在搜索项目上下文... docs:search "项目概览"
AI: 基于项目背景，我建议采用以下方案...
AI: docs:create task "用户管理模块开发"

4. 管理任务和进展

# 创建新任务
docs:create task "添加用户管理功能"

# 更新任务进展
docs:update "任务文档.md" "status:进行中" "progress:完成基础组件"

# 查看项目状态
docs:status

# 搜索相关文档
docs:search "用户管理"

🎮 体验演示

# 克隆仓库后运行
npm run demo

# 或者直接运行演示脚本
./demo.sh

演示将创建一个示例项目，展示完整的使用流程。

📚 文档类型

• task: 任务跟踪和进展记录
• bug: 问题分析和修复过程
• decision: 重要技术决策记录
• context: 项目背景和技术信息

💡 最佳实践

1. 项目启动时先创建context文档
2. 每个任务开始前搜索相关文档
3. 定期更新任务进展和状态
4. 重要决策都要记录在decision文档中

🔗 相关资源

• 📖 完整文档 - 详细的使用说明
• ⚡ 快速示例 - 实际使用场景
• 🛠️ 安装指南 - 详细的安装步骤
• 🎮 在线演示

🤝 贡献

我们欢迎各种形式的贡献！

• 🐛 报告问题：Issues
• 💡 提出建议：Discussions
• 🔧 提交代码：Pull Requests

📄 许可证

MIT License - 详见 LICENSE 文件

⭐ 支持

如果这个项目对你有帮助，请给我们一个 ⭐️！

让AI成为你最得力的开发伙伴！ 🚀