mcpField
P
planning-with-files

planning-with-files

github.com/jd-opensourceAgent 工作流31540 次安装28 周前更新
代码仓库

关于 planning-with-files

供 Agent 处理复杂多步骤任务的规划技能。它用项目目录中的 Markdown 文件记录计划、发现和进度,并提供会话恢复流程,持续保存决策与错误。

主要功能

  1. 01持久化 Markdown 规划文件
  2. 02阶段与进度跟踪
  3. 03研究发现记录
  4. 04会话上下文恢复
  5. 05错误记录与重试指引

适用场景

  1. 01组织多步骤研究
  2. 02跨会话跟踪任务
  3. 03记录浏览器或图像检查所得
  4. 04管理实施阶段与错误

安装

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

$npx skills add https://github.com/jd-opensource/joysafeter --skill planning-with-files

安装后在 Claude Code 中输入/planning-with-files确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

examples.md
reference.md
scripts/
check-complete.ps1
check-complete.sh
init-session.ps1
init-session.sh
session-catchup.py
templates/
findings.md
progress.md
task_plan.md

详细介绍

使用文件进行规划

像 Manus 一样工作:使用持久化的 Markdown 文件作为“磁盘上的工作记忆”。

首先:检查之前的会话(v2.2.0)

开始工作前,检查之前会话中是否有尚未同步的上下文:

python3 ${CLAUDE_PLUGIN_ROOT}/scripts/session-catchup.py "$(pwd)"

如果追赶报告显示有尚未同步的上下文:

  1. 运行 git diff --stat 查看实际的代码更改
  2. 阅读当前的规划文件
  3. 根据追赶报告和 git diff 更新规划文件
  4. 然后继续任务

重要提示:文件存放位置

  • 模板位于 ${CLAUDE_PLUGIN_ROOT}/templates/
  • 规划文件放在项目目录中
位置存放内容
技能目录(${CLAUDE_PLUGIN_ROOT}/)模板、脚本、参考文档
项目目录task_plan.md、findings.md、progress.md

快速入门

开始任何复杂任务前:

  1. 创建 task_plan.md —— 参考 templates/task_plan.md
  2. 创建 findings.md —— 参考 templates/findings.md
  3. 创建 progress.md —— 参考 templates/progress.md
  4. 做决定前重新阅读计划 —— 将目标刷新到注意力窗口中
  5. 每个阶段结束后更新 —— 标记完成状态并记录错误

注意: 规划文件应放在项目根目录,而不是技能安装目录中。

核心模式

Context Window = RAM (volatile, limited)
Filesystem = Disk (persistent, unlimited)

→ Anything important gets written to disk.

文件用途

文件用途更新时间
task_plan.md阶段、进度、决策每个阶段结束后
findings.md研究、发现每次有新发现后
progress.md会话日志、测试结果整个会话期间

关键规则

1. 先创建计划

没有 task_plan.md,绝不开始复杂任务。这是必须遵守的规则。

2. 两次操作规则

“每进行 2 次查看、浏览器或搜索操作后,立即将关键发现保存到文本文件中。”

这可以防止视觉或多模态信息丢失。

3. 决策前先阅读

做出重大决策前,先阅读计划文件。这能让目标保持在注意力窗口中。

4. 操作后更新

完成任何阶段后:

  • 将阶段状态从 in_progress 更新为 complete
  • 记录遇到的错误
  • 记下创建或修改的文件
5. 记录所有错误

将每个错误都记入计划文件。这有助于积累知识并避免重复犯错。

## Errors Encountered
| Error | Attempt | Resolution |
|-------|---------|------------|
| FileNotFoundError | 1 | Created default config |
| API timeout | 2 | Added retry logic |
6. 切勿重复失败
if action_failed:
    next_action != same_action

记录尝试过的方法。调整解决方案。

三次错误处理协议

ATTEMPT 1: Diagnose & Fix
  → Read error carefully
  → Identify root cause
  → Apply targeted fix

ATTEMPT 2: Alternative Approach
  → Same error? Try different method
  → Different tool? Different library?
  → NEVER repeat exact same failing action

ATTEMPT 3: Broader Rethink
  → Question assumptions
  → Search for solutions
  → Consider updating the plan

AFTER 3 FAILURES: Escalate to User
  → Explain what you tried
  → Share the specific error
  → Ask for guidance

读取与写入决策矩阵

情况操作原因
刚写入文件不要读取内容仍在上下文中
查看了图像或 PDF立即写下发现在多模态信息丢失前将其转为文本
浏览器返回了数据写入文件屏幕截图不会持久保存
开始新阶段阅读计划和发现如果上下文已过时,重新确定方向
发生错误阅读相关文件修复问题需要了解当前状态
间隔一段时间后恢复工作阅读所有规划文件恢复工作状态

五问重启测试

如果你能回答以下问题,说明上下文管理得当:

问题答案来源
我现在在哪里?task_plan.md 中的当前阶段
接下来要去哪里?剩余阶段
目标是什么?计划中的目标陈述
我学到了什么?findings.md
我做了什么?progress.md

何时使用此模式

适用于:

  • 多步骤任务(3 步以上)
  • 研究任务
  • 构建或创建项目
  • 涉及多次工具调用的任务
  • 任何需要组织安排的工作

不适用于:

  • 简单问题
  • 单文件编辑
  • 快速查询

模板

复制以下模板以开始:

脚本

用于自动化的辅助脚本:

  • scripts/init-session.sh — 初始化所有规划文件
  • scripts/check-complete.sh — 验证所有阶段是否已完成
  • scripts/session-catchup.py — 从上一次会话恢复上下文(v2.2.0)

高级主题

反模式

不要这样做建议做法
使用 TodoWrite 进行持久化创建 task_plan.md 文件
只陈述一次目标,然后置之不理在做出决定前重新阅读计划
隐瞒错误并静默重试将错误记录到计划文件中
把所有内容都塞进上下文将大量内容存储在文件中
立即开始执行首先创建计划文件
重复失败的操作跟踪尝试次数,调整方法
在技能目录中创建文件在项目中创建文件

评论

支持 Markdown