Skip to content

Repository files navigation

Copilot工作流系统

🌍 语言版本: English | 中文

⚠️ 停止维护:本工作流项目已停止维护。请使用新版 Skills 项目:https://github.com/Linearl/linearleaf_skill_repo

基于GitHub Copilot的全面工作流系统,用于系统化调试、文件整理、代码分析、重构与版本差异分析。

🎯 核心理念

"流程即工具,工具即杠杆"

"新工具不是旧方法的延伸,而是新可能性的宣言。" ——凯文·凯利

工具的本质是「可复用的杠杆」,而流程是「工具的工业化封装」。正如凯文·凯利所言,"过去200年来最伟大的发明并非具体的工具,而是科学方法本身——这种可靠地产生创新的流程"

本系统体现了这一理念,将调试、文件整理和代码分析从临时性活动转化为系统化、可复制的流程,成为AI辅助开发的强大杠杆工具。

💡 扩展与定制: 您可以利用这些现有工作流作为模板,借助Copilot的帮助开发自己的专门工作流,然后在实践中逐步调优。

🚀 使用工作流的优势

🎯 增强专注力与上下文管理

工作流经过充分的测试和调优,可以让AI模型在完成复杂工作的过程中,专注目标并自动维护上下文。这种结构化方法防止AI在多步骤过程中偏离原始目标。

💰 优化请求效率

使用工作流可以有效减少和Copilot的交互次数,让单次请求可以完成更多工作,进而节约高级请求次数,带来直接的成本效益。

🔄 系统化可重现性

工作流确保在不同会话和用户间获得一致的结果,将临时性问题解决转化为可靠、可重复的流程,并能够随时间不断完善和改进。

🎯 核心工作流

本系统提供六个主要工作流,专为AI辅助开发设计:

1. 调试工作流

模板: debug-system/debug_workflow_template.md 说明: 系统化调试流程,采用6步调试循环确保问题解决的一致性。

功能特点:

  • 结构化问题解决方法
  • 可重现的调试技术
  • 全面的文档系统
  • 人工验证检查点

2. 文件整理工作流

模板: file-organize-system/file_organize_workflow_template.md 说明: 全面的文件整理系统,包含三大整理方式和系统化清理流程。

功能特点:

  • 优先级导向整理
  • 类型导向分类
  • 时间线导向排序
  • 系统化清理流程
  • 符号分类文件管理

3. 分析工作流

模板: analysis_system/analysis_workflow_template.md 说明: 全面的代码分析和质量评估系统,采用多维度分析方法进行技术债务识别、性能优化和重构指导。

功能特点:

  • 多维度代码分析
  • 自动化工具和指标收集
  • 系统化报告生成
  • 模板驱动流程

4. 重构工作流

模板: refactor_system/refactor_workflow_template.md 说明: 基于代码分析结果的系统化重构工作流,采用三层级计划管理和双层循环执行机制。

功能特点:

  • 三层级计划体系(总体→阶段→实施)
  • P0-P3优先级驱动的阶段管理
  • 双层循环控制(阶段级+修改点级)
  • 可视化流程图指导
  • 风险控制和回滚机制

5. 版本对比工作流

模板: version-comparison-system/version-comparison-workflow-template.md 说明: 面向多版本差异分析的结构化工作流,支持Git worktree隔离、模块化阶段分析与版本报告生成。

功能特点:

  • 三阶段(概览→模块→文档)分层分析
  • 底层到高层的模块顺序(tools→logic→algorithm)
  • Git差异统计与提交分类
  • 工作流模板驱动的记录与报告
  • 更新日志补充与升级指导输出

6. 工作流构建器

模板: workflow-builder-system/workflow_builder_template.md 说明: 基于IPD集成产品开发方法论的智能化工作流构建系统,通过AI引导设计新工作流。

功能特点:

  • AI引导式需求澄清: 3-5轮对话完成需求收集
  • IPD 6阶段门控制: 概念→分析→概念设计→详细设计→开发构建→质量验证
  • 24个设计模式库: 从现有工作流提取的可复用设计模式
  • 插件化验证系统: 完整性、易用性、可维护性、文档质量、扩展性评估
  • 三种复杂度方案: 轻量级/标准/专业级,支持不同技能水平用户

📁 项目结构

copilot_workflows/
├── workflow-builder-system/            # 工作流构建器系统
│   ├── workflow_builder_template.md    # 主工作流模板
│   ├── README.md                       # 系统说明文档
│   ├── README_en.md                    # English documentation
│   ├── templates/                      # 模板组件库
│   ├── tools/                          # 自动化构建工具
│   │   ├── validator.py                # 工作流验证器(插件化重构版)
│   │   ├── plugin_template.py          # 插件开发模板
│   │   └── plugins/                    # 质量评估插件系统
│   ├── builds/                         # 构建输出目录
│   ├── docs/                           # 文档目录
│   │   └── appendix-design-patterns.md # 24个设计模式库
│   └── logs/                           # 运行日志目录
├── debug-system/                       # 调试工作流支持文件
│   ├── debug_workflow_template.md      # 调试工作流模板
│   ├── templates/                      # 调试模板集合
│   ├── docs/                           # 符号参考指南
│   └── buglist/                        # Bug跟踪和解决归档
├── file-organize-system/               # 文件整理工作流支持文件
│   ├── file_organize_workflow_template.md # 文件整理工作流模板
│   ├── templates/                      # 整理模板集合
│   ├── docs/                           # 操作指南和最佳实践
│   ├── tools/                          # 整理工具和实用程序
│   ├── organize/                       # 整理任务工作目录
│   └── version.md                      # 版本历史
├── analysis_system/                    # 代码分析工作流支持文件
│   ├── analysis_workflow_template.md   # 分析工作流模板
│   ├── README.md                       # 分析系统文档
│   ├── templates/                      # 分析模板集合
│   ├── tools/                          # 分析工具和实用程序
│   ├── tasks/                          # 分析任务归档目录
│   ├── docs/                           # 分析文档资料
│   └── case-studies/                   # 分析案例研究
├── refactor_system/                    # 重构工作流支持文件
│   ├── refactor_workflow_template.md   # 重构工作流模板
│   ├── README.md                       # 重构系统文档(中文)
│   ├── README_en.md                    # 重构系统文档(英文)
│   ├── templates/                      # 重构模板集合
│   ├── tools/                          # 重构工具和实用程序
│   └── tasks/                          # 重构任务归档目录
├── version-comparison-system/          # 版本对比工作流支持文件
│   ├── version-comparison-workflow-template.md
│   ├── README.md
│   ├── README_en.md
│   └── templates/
├── .copilot-instructions.md            # Copilot AI协作指令
├── git-commit-workflow.md              # Git提交工作流规范
├── README.md                           # 主要文档(中文)
├── README_en.md                        # 英文文档
└── LICENSE                             # MIT许可证

🧾 作者的话 / Author's Note

查看工作流体系的设计动机、边界与实践经验总结: 作者的话 (AUTHOR_NOTE.md)

🚀 快速开始

1. 克隆仓库

git clone https://github.com/Linearl/copilot_workflows.git
cd copilot_workflows

2. 启用Copilot Agent模式

配置您的VS Code Copilot以使用代理模式,以获得最佳的工作流支持。

3. 选择您的方式

您可以通过两种方式使用工作流:

⚡ 方式A:手动工作流

3A. 直接使用模板

在VS Code中打开相应的工作流模板:

# 调试任务
code debug-system/debug_workflow_template.md

# 文件整理任务
code file-organize-system/file_organize_workflow_template.md

# 代码分析任务
code analysis_system/analysis_workflow_template.md

# 重构任务
code refactor_system/refactor_workflow_template.md

# 版本对比任务
code version-comparison-system/version-comparison-workflow-template.md

# 工作流构建任务
code workflow-builder-system/workflow_builder_template.md

📝 说明: 这些是模板文件。实际的工作流文档会在开始工作流程时自动生成。

4A. 自然语言交互

只需用自然语言描述你的问题或整理任务 - 工作流会自动处理解析和格式化:

⚡ 方式B:自动触发工作流

3B. 配置自动触发

步骤1:创建指令文件

在项目中创建 .github/copilot-instructions.md 文件来启用自动工作流触发:

步骤2:配置VS Code设置

在VS Code的 settings.json 中添加以下配置:

{
  "github.copilot.chat.codeGeneration.instructions": [
    {"file": ".github/copilot-instructions.md"}
  ]
}

步骤3:指令文件内容

# Copilot 工作流指令

## 自动触发条件

### 调试工作流触发
当用户提到: debugging, error fixing, troubleshooting, bug resolution, code issues
自动建议: "我注意到您在进行调试工作。是否需要我启动系统化调试工作流?我可以创建结构化的调试会话文档来帮助组织故障排除过程。"

### 文件整理工作流触发  
当用户提到: file organization, cleanup, directory restructure, file management, project organization
自动建议: "我看到您需要文件整理协助。是否需要我启动文件整理工作流?我可以帮助您使用优先级导向、类型导向或时间线导向的方式系统地整理文件。"

### 分析工作流触发
当用户提到: code analysis, code quality, performance optimization, technical debt, refactoring, architecture review
自动建议: "我看到您需要代码分析协助。是否需要我启动分析工作流?我可以帮助您系统地分析代码质量,识别技术债务,并提供优化建议。"

### 重构工作流触发
当用户提到: code refactoring, system refactoring, architecture improvement, code restructuring, refactor plan
自动建议: "我看到您需要代码重构协助。是否需要我启动重构工作流?我可以帮助您基于分析结果制定系统化的重构计划并安全地执行重构任务。"

### 版本对比工作流触发
当用户提到: version comparison, diff analysis, change tracking, version control, git diff
自动建议: "我看到您需要版本对比协助。是否需要我启动版本对比工作流?我可以帮助您系统地分析版本差异,跟踪变更,并生成全面的报告。"

### 工作流构建器触发
当用户提到: workflow design, workflow building, custom workflow, workflow development, workflow creation
自动建议: "我看到您需要工作流构建协助。是否需要我启动工作流构建器?我可以帮助您使用IPD方法论和我们的24个设计模式库设计并创建自定义工作流。"

## 工作流模板
- 调试模板: `debug-system/debug_workflow_template.md`
- 文件整理模板: `file-organize-system/file_organize_workflow_template.md`
- 分析模板: `analysis_system/analysis_workflow_template.md`
- 重构模板: `refactor_system/refactor_workflow_template.md`
- 版本对比模板: `version-comparison-system/version-comparison-workflow-template.md`
- 工作流构建器模板: `workflow-builder-system/workflow_builder_template.md`

4B. 自然语言交互

配置完成后,只需在对话中提及您的需求 - AI会自动建议合适的工作流:

触发示例:

  • "我需要调试这个错误..." → 调试工作流建议
  • "我想要整理这些文件..." → 文件整理工作流建议
  • "我需要分析这个代码质量..." → 分析工作流建议
  • "我需要重构这个项目..." → 重构工作流建议
  • "我想要对比这些版本..." → 版本对比工作流建议
  • "我想要创建自定义工作流..." → 工作流构建器建议

⚠️ 重要提醒: 执行复杂任务时可能需要多次点击"继续"或与AI进行深入交互。为确保AI始终遵循工作流要求,建议在长时间运行的任务中:

  • 将任务专用工作流文档保持在前台编辑器中
  • 或手动将工作流文档添加到对话上下文

这样可以避免因对话上下文过长导致AI偏离工作流规范的问题。

📋 工作流执行详情

调试工作流流程

📄 工作文档: 在 debug-system/debug_workflow_[任务名].md 中创建

  1. 问题描述: 自然地描述你的调试问题
  2. AI分析: 让agent解析并理解你的问题
  3. 用户确认: 检查并确认agent的理解
  4. 文档创建: Agent创建任务专用工作流文档
  5. 环境设置: 初始化有组织的调试工作空间
  6. 调试迭代: 执行结构化调试循环
  7. 文档记录: 记录结果并整理文件

文件整理工作流流程

📄 工作文档: 在 file-organize-system/file_organize_workflow_[任务名].md 中创建

  1. 整理目标: 定义您的文件整理目标
  2. 现状分析: 评估现有文件结构和问题
  3. 用户确认: 确认整理策略和优先级
  4. 文档创建: 创建任务专用整理工作流
  5. 环境设置: 准备整理工作空间和工具
  6. 整理执行: 执行系统化文件整理
  7. 文档记录: 记录整理过程和结果

分析工作流流程

📄 工作文档: 在 analysis_system/tasks/[任务ID]/analysis_workflow_[任务名].md 中创建

  1. 项目分析: 理解项目结构和分析需求
  2. 分析规划: 定义分析范围、维度和成功标准
  3. 环境设置: 初始化分析工作空间和工具
  4. 多维度分析: 执行代码结构、质量、性能和安全性分析
  5. 报告生成: 生成包含指标和建议的全面分析报告
  6. 文档记录和归档: 记录分析过程并归档结果

重构工作流流程

📄 工作文档: 在 refactor_system/tasks/[任务编号]/refactor_workflow_[任务名].md 中创建

  1. 输入收集: 提供分析结果和重构要求
  2. 总体规划: 制定Level1整体计划,设定P0-P3优先级
  3. 用户确认: 确认重构计划和实施优先级
  4. 环境初始化: 创建专题目录和三层级计划文档
  5. 双层循环执行: 按阶段进行重构实施(外层:阶段级,内层:修改点级)
  6. 验证总结: 完成验证和文档归档

版本对比工作流流程

📄 工作文档: 在 version-comparison-system/[任务名]/version-comparison-workflow_[任务名].md 中创建

  1. 版本选择: 选择需要对比的版本
  2. 概览分析: 执行快速的版本差异概览分析
  3. 模块分析: 针对关键模块执行深入分析
  4. 文档生成: 自动生成分析文档和更新日志
  5. 结果确认: 人工确认分析结果和修复建议
  6. 归档与清理: 归档分析文档,清理临时文件

工作流构建器流程

📄 工作文档: 在 workflow-builder-system/builds/[构建会话]/workflow_build_[任务名].md 中创建

  1. 需求澄清: AI引导的3-5轮对话,收集完整需求
  2. IPD门控: 6阶段门控过程,从概念到质量验证
  3. 设计模式选择: 从24个验证过的设计模式中选择
  4. 工作流构建: 使用选定模式和IPD方法论构建工作流
  5. 插件验证: 评估完整性、易用性、可维护性、文档质量和扩展性
  6. 部署: 生成最终工作流模板和文档

🎯 功能特点

调试工作流功能

  • 6步调试循环: 系统化问题解决方法
  • 结构化问题分解: 将复杂问题分解为可管理的部分
  • 文档系统: 全面的日志记录和知识捕获
  • 人工验证检查点: 确保准确性和用户控制

文件整理工作流功能

  • 多种整理策略: 优先级导向、类型导向和时间线导向方法
  • 系统化清理流程: 全面的文件清理和归档流程
  • 符号分类系统: 全面的项目组织符号指南

分析工作流功能

  • 多维度分析: 代码结构、质量、性能、安全性和技术债务评估
  • 自动化工具: 代码指标收集器、依赖关系分析器和报告生成器
  • 系统化报告: 带有量化指标和可行见解的结构化分析报告
  • 模板驱动流程: 标准化模板确保项目间分析的一致性

重构工作流功能

  • 三层级计划体系: Level1总体计划 → Level2阶段计划 → Level3实施计划
  • 优先级驱动: P0-P3优先级管理和阶段化执行
  • 双层循环控制: 阶段级外循环和修改点级内循环
  • 可视化指导: Mermaid流程图提供可视化执行指导
  • 风险控制: 渐进式实施、回滚机制和质量保证

版本对比工作流功能

  • 三阶段分层分析: 概览→模块→文档
  • 模块化顺序分析: 从底层到高层(tools→logic→algorithm)
  • Git差异统计: 自动统计差异文件和提交
  • 模板驱动报告: 基于模板生成结构化报告
  • 更新日志生成: 自动生成更新日志和升级建议

工作流构建器功能

  • AI引导式需求收集: 3-5轮对话完成完整需求收集
  • IPD 6阶段门控制: 概念→分析→概念设计→详细设计→开发构建→质量验证
  • 24个设计模式库: 从现有工作流提取的可复用设计模式
  • 插件化验证: 完整性、易用性、可维护性、文档质量、扩展性评估
  • 三种复杂度选项: 轻量级/标准/专业级,支持不同技能水平用户

共享功能

  • 模块化结构: 有序的文件系统,提高工作流会话效率
  • 模板系统: 标准化模板确保文档和流程的一致性

🆕 工作流构建器:智能化工作流设计

🎯 设计理念

工作流构建器代表了我们对"如何系统化地构建工作流"这一问题的最新思考。它不是简单的模板集合,而是一个完整的工作流设计方法论的实现:

核心洞察

  • 每个人都有独特的工作场景,但背后的设计原则是通用的
  • AI擅长对话澄清需求,但需要结构化的引导框架
  • 从需求到实现的鸿沟可以通过系统化的设计阶段来填平
  • 质量保证应该内置在构建过程中,而不是事后检查

🏗️ 核心创新

1. IPD + AI 的深度融合

  • 6个阶段门确保每个环节都有明确的交付物和验证标准
  • AI引导式对话降低需求澄清的认知负担
  • 多轮迭代优化平衡效率和质量

2. 24个设计模式的沉淀

基于对现有5个工作流的深度分析,我们提取了24个可复用的设计模式:

  • 架构设计模式 (6个):统一文档结构、阶段化流程、层次化目录等
  • 交互控制模式 (6个):多层循环控制、交互式引导、强制确认检查点等
  • 任务管理模式 (4个):任务分解优先级、时间盒管理、资源依赖管理等
  • 技术实现模式 (4个):模板驱动生成、脚本自动化、配置参数化等
  • 质量保证模式 (2个):多重验证、版本化归档
  • 认知优化模式 (2个):认知负载管理、学习曲线优化

3. 插件化验证系统

  • 质量评估插件:完整性、易用性、可维护性、文档质量、扩展性
  • 扩展插件支持:安全性、性能、测试覆盖率等
  • 插件开发模板:标准化的插件开发框架

🎮 使用体验设计

三步快速启动

  1. 明确需求 (5分钟) - 写下问题、理想方案、约束条件
  2. 启动会话 (2分钟) - 描述需求,AI接管引导
  3. 跟随AI (按复杂度) - 多轮对话完成设计,一键生成系统

AI引导式需求澄清

  • 每次2-3个相关问题,避免认知过载
  • 通常3-5轮对话完成需求收集
  • 自动生成多个方案供选择
  • 交互生成完整工作流系统

🔄 与现有工作流的关系

工作流构建器既是元工作流(生成其他工作流的工作流),也是对我们3个月AI协作经验的系统化总结:

融合现有经验

  • 调试工作流的"循环控制机制"→ 多层循环控制模式
  • 分析工作流的"阶段化流程"→ 阶段化流程模式
  • 重构工作流的"渐进式设计"→ 渐进式复杂度模式
  • 文件整理的"模板驱动"→ 模板驱动生成模式
  • 版本对比的"多重验证"→ 多重验证模式

超越现有限制

  • 降低门槛:从"需要工作流经验"到"零门槛AI引导"
  • 提升效率:从"手工设计"到"快速生成"
  • 保证质量:从"人工检查"到"插件化验证"
  • 支持规模化:从"个人使用"到"团队标准化"

💻 快速开始

如果你想快速创建一个新的工作流,强烈建议先使用工作流构建器

请启动工作流构建器,帮我设计一个解决方案。

我的需求是:[描述你的具体需求]

优势

  • AI会引导你澄清需求,避免遗漏关键要素
  • 自动应用24个设计模式,确保结构合理
  • 生成完整的模板和工具支持
  • 内置质量验证,减少后期返工

🛠 如何开发你自己的工作流(实践建议)

📋 快速路径:使用工作流构建器

如果你想快速创建一个新的工作流,强烈建议先使用工作流构建器

请启动工作流构建器,帮我设计一个解决方案。

我的需求是:[描述你的具体需求]

优势

  • AI会引导你澄清需求,避免遗漏关键要素
  • 自动应用24个设计模式,确保结构合理
  • 生成完整的模板和工具支持
  • 内置质量验证,减少后期返工

🔧 深度定制:手工设计方法

如果你需要深度定制或想学习设计原理,可以参考以下方法:

1. 从"线性(顺序)型"开始

早期不要急于设计包含大量分支 / 嵌套循环的复杂流程。

2. 先做"模板容器",再做"策略规则"

AI 擅长填空,不擅长"无模板即兴严肃组织"。

3. 选一个真实痛点场景反复使用

观察"AI 易出错点 / 赘述点 / 遗漏点",再反向写入模板。

4. 控制模板密度

删掉不会被有效利用的章节;保留"关键决策+标准检查+成果出口"三类块。

5. 引入经验法则(heuristics)

  • 延迟冲动:例如"遇到结构未扫清,不立刻优化实现"
  • 双重审查:完成后再用"异常扫描清单"过一遍
  • 节奏锚点:固定时间 / 文件数 / 阶段总结(防上下文漂移)

6. 逐次内化

把"这次临时提示里效果好的语句"沉淀为模板固定段落。

📐 模板设计经验(关键要点)

关注点 反模式 改进策略
章节过多 AI 忽略后半段 分级:必填 / 可选 / 扩展;可选标注注释说明
抽象术语 AI 生成空洞描述 用具体检验维度替换(示例:复杂度、耦合度、接口变化)
指令歧义 AI 自行发挥 用"禁止做 / 必须暂停点"显式声明控制点
总结缺验证 结果口号化 强制加入"证据引用 / 文件路径 / diff 依据"
缺失败处理 一遇异常停摆 设计"异常兜底块":降级策略 / 手动介入指引

🧪 让 AI "三思而后行" 的技巧

  • 约束结构:明确阶段入口 / 退出条件 / 产出格式
  • 复盘插槽:每轮循环末尾插入"自检:是否遗漏 X / 是否偏离任务目标"
  • 任务冻结:阶段确认后,前序阶段内容仅允许追加"补充区",禁止整体重写
  • 角色切换:在关键步骤引导 AI 临时"扮演审查者"而非继续生成者

📖 文档说明

主要文档

  • 工作流构建器文档:

  • 调试工作流文档:

  • 文件整理工作流文档:

    • 中文说明: 详细的文件整理工作流中文说明 (即将推出)
    • English Guide: 综合文件整理英文指南 (即将推出)
  • 分析工作流文档:

  • 重构工作流文档:

  • 版本对比工作流文档:

    • 中文说明: 详细的版本对比工作流中文说明
    • English Guide: 综合版本对比工作流英文指南 (即将推出)

符号参考

详细的符号使用和文件分类指南,请参见:

🤝 贡献指南

我们欢迎贡献!请随时提交Pull Request。对于重大更改,请先开启issue讨论您想要更改的内容。

📄 许可证

本项目采用MIT许可证 - 详情请参阅 LICENSE 文件。

📋 更新日志

查看详细的版本更新历史和变更内容,请参阅:更新日志


创建时间: 2025年6月21日 最后更新: 2025年8月18日 当前版本: v3.0.0 适用场景: 技术项目调试、问题排查、系统优化、文件整理、项目清理、代码分析、质量评估、代码重构、架构改进、版本差异分析、工作流设计

About

Workflows using copilot in VSCode

Resources

Stars

14 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages