Skip to content

docs(speculo): workflows/matt-pocock 缺少用户使用指南 README #2

Description

@NAMEWTA

痛点

speculo/workflows/matt-pocock/ 目录当前没有面向用户的 README 文档。新用户需要:

  • 读取 12+ 个文件才能拼出完整使用心智模型
  • WORKFLOW.md 是面向机器执行的 XML 编排声明,不是教学文档
  • 10 条路由的触发条件(when)分散在各 route 文件中,无法一览
  • Change 生命周期、命名规范、状态转移规则散落多处
  • 三层上下文隔离机制(状态命名空间 / worktree / vendor 重定向)缺少说明

建议

speculo/workflows/matt-pocock/README.md 增加用户使用指南,包含:

1. 快速开始(Golden Path)

  • 最小可用示例:一句提示词 → 创建 change → grill → spec → implement → finalize
  • 接续已有 change 的示例:新会话如何通过 status.json 恢复上下文

2. 路由速查表

  • 10 条路由的触发条件、适用场景、关键产物一览表

3. 核心概念

  • Change 命名格式 YYYY-MM-DD-<kebab-topic>
  • 状态机:active → completed → archived
  • 路由间转移规则

4. 上下文隔离机制

  • 第一层:.speculo/<workflow>/ 状态命名空间隔离
  • 第二层:git worktree 物理代码隔离
  • 第三层:vendor skill 路径重定向,不污染项目根

5. 目录结构图

  • 完整的文件树及每个目录/文件的用途注释

标签

  • documentation
  • enhancement
  • ready-for-agent

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestready-for-agent已完整定义,可供离线 Agent 执行

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions