mcpField
W
writing-plans

writing-plans

github.com/itallstartedwithaideaAgent 工作流4476 次安装29 周前更新
代码仓库

关于 writing-plans

将实现任务拆解为有序的原子步骤,并列出准确的文件位置、代码修改和验证命令。该技能适用于为 Agent 安排执行、交接或后续恢复的工作,无需依赖原始对话上下文。

主要功能

  1. 01原子化实现步骤
  2. 02准确的文件路径与代码修改
  3. 03每步完成后的验证
  4. 04按依赖关系安排步骤
  5. 05破坏性修改的回滚说明

适用场景

  1. 01规划涉及多个文件的修改
  2. 02将实现任务交接给其他 Agent
  3. 03在没有原始对话时恢复工作
  4. 04把复杂重构拆成可验证步骤

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/itallstartedwithaidea/agent-skills --skill writing-plans

安装后在 Claude Code 中输入/writing-plans确认已加载。

详细介绍

编写计划

Agent Skills™ 的一部分,由 googleadsagent.ai™ 提供

描述

编写计划会将任意实现任务拆分为一系列原子步骤,每步都能在 2-5 分钟内完成,并包含确切的文件路径、完整代码块和验证命令。该计划是一份独立的执行脚本,其他 Agent 或同一 Agent 的未来版本都能遵循它,而无需原始对话上下文。

计划与待办清单的关键区别在于具体程度。计划不会只说“更新 API 处理程序”,而是会说“在 src/api/routes/users.ts 的第 47 行添加一个 GET /users/:id/preferences 处理程序,使其返回一个包含 theme、locale 和 notifications 字段的 UserPreferences 对象,并使用 src/api/schemas.ts 中定义的 preferencesSchema 进行验证。”每个步骤都足够明确,可以按步骤机械执行。

计划会在每个实现步骤之后加入验证步骤:运行测试、执行 curl 命令,或确认 UI 状态。这个紧密的反馈循环可确保立即发现错误,避免错误在后续步骤中不断累积。

适用场景

  • 任务涉及修改 3 个或更多文件
  • 实现路径已知,但执行并非易事
  • 工作需要移交给其他 Agent,或稍后继续
  • 用户要求制定计划、路线图或分步骤说明
  • 需要在着手实现前估算工作量
  • 复杂重构需要精确安排变更顺序

工作原理

graph TD
    A[Task Description] --> B[Identify Affected Files]
    B --> C[Determine Change Order]
    C --> D[Write Step 1: File + Code + Verify]
    D --> E[Write Step 2: File + Code + Verify]
    E --> F[Write Step N: File + Code + Verify]
    F --> G[Add Rollback Instructions]
    G --> H[Estimate Total Duration]
    H --> I[Present Plan for Approval]
    I -->|Approved| J[Save as plan.md]
    I -->|Needs Revision| B

每个计划步骤都遵循严格的结构:要修改的文件、确切的代码变更(包含修改前后的上下文),以及用于确认步骤成功的验证命令。步骤按顺序排列,确保每个检查点的代码库都能正常运行。

实现

# Plan: Add User Preferences API

**Estimated Duration**: 15 minutes (5 steps × 3 min avg)
**Affected Files**: 4 files modified, 1 file created

## Step 1: Define Schema (2 min)
**File**: `src/api/schemas.ts`
**Action**: Add after line 23

  export const preferencesSchema = z.object({
    theme: z.enum(["light", "dark", "system"]).default("system"),
    locale: z.string().regex(/^[a-z]{2}-[A-Z]{2}$/).default("en-US"),
    notifications: z.boolean().default(true),
  });
  export type UserPreferences = z.infer<typeof preferencesSchema>;

**Verify**: `npx tsc --noEmit` exits 0

## Step 2: Add Database Migration (3 min)
**File**: `src/db/migrations/004_user_preferences.sql` (CREATE)

  CREATE TABLE user_preferences (
    user_id TEXT PRIMARY KEY REFERENCES users(id),
    theme TEXT NOT NULL DEFAULT 'system',
    locale TEXT NOT NULL DEFAULT 'en-US',
    notifications BOOLEAN NOT NULL DEFAULT true
  );

**Verify**: `npx wrangler d1 migrations apply buddy-brain --local`

## Step 3: Add Route Handler (3 min)
**File**: `src/api/routes/users.ts`
**Action**: Add after the existing GET /users/:id handler

  // ... [complete handler code here]

**Verify**: `curl localhost:8787/users/test-id/preferences` returns 200

最佳实践

  • 每个步骤完成后,代码库都必须处于可编译、可运行的状态
  • 为每项变更提供完整代码,绝不要写“类似上文”
  • 按依赖关系安排步骤,先处理依赖项(先处理 schema,再处理处理程序;先处理类型,再处理实现)
  • 对破坏性变更(迁移、删除)添加回滚说明
  • 每个步骤控制在 2-5 分钟内;更大的任务要拆分
  • 添加行号或周边上下文,以便精确定位插入点

平台兼容性

平台支持情况备注
Cursor完全支持计划保存为工作区文件
VS Code完全支持Markdown 计划文件
Windsurf完全支持计划并执行工作流
Claude Code完全支持TodoWrite + 计划文件
Cline完全支持基于任务的规划
aider完全支持每步提交一次并执行

相关技能

  • 头脑风暴 - 通过苏格拉底式设计完善,产出编写计划所依据的设计简报
  • 执行计划 - 批量执行引擎,推动书面计划完成验证和回滚
  • 子 Agent 驱动开发 - 将计划步骤拆解为独立的子 Agent 规范

关键词

planning task-decomposition step-by-step implementation-plan file-paths verification-steps atomic-steps handoff-ready


© 2026 googleadsagent.ai™ | Agent Skills™ | MIT License

评论

支持 Markdown